forked from swiftwasm/JavaScriptKit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathImportTS.swift
More file actions
1050 lines (971 loc) · 42.8 KB
/
ImportTS.swift
File metadata and controls
1050 lines (971 loc) · 42.8 KB
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
import SwiftBasicFormat
import SwiftSyntax
import SwiftSyntaxBuilder
#if canImport(BridgeJSSkeleton)
import BridgeJSSkeleton
#endif
#if canImport(BridgeJSUtilities)
import BridgeJSUtilities
#endif
/// Imports TypeScript declarations and generates Swift bridge code
///
/// This struct processes TypeScript definition files (.d.ts) and generates:
/// 1. Swift code to call the JavaScript functions from Swift
/// 2. Skeleton files that define the structure of the imported APIs
///
/// The generated skeletons will be used by ``BridgeJSLink`` to generate
/// JavaScript glue code and TypeScript definitions.
public struct ImportTS {
public let progress: ProgressReporting
public private(set) var skeleton: ImportedModuleSkeleton
private let moduleName: String
public init(progress: ProgressReporting, moduleName: String, skeleton: ImportedModuleSkeleton) {
self.progress = progress
self.moduleName = moduleName
self.skeleton = skeleton
}
/// Finalizes the import process and generates Swift code
public func finalize() throws -> String? {
var decls: [DeclSyntax] = []
for skeleton in self.skeleton.children {
try withSpan("Render Global Getters") {
for getter in skeleton.globalGetters {
let getterDecls = try renderSwiftGlobalGetter(getter, topLevelDecls: &decls)
decls.append(contentsOf: getterDecls)
}
}
try withSpan("Render Functions") {
for function in skeleton.functions {
let thunkDecls = try renderSwiftThunk(function, topLevelDecls: &decls)
decls.append(contentsOf: thunkDecls)
}
}
try withSpan("Render Types") {
for type in skeleton.types {
let typeDecls = try renderSwiftType(type, topLevelDecls: &decls)
decls.append(contentsOf: typeDecls)
}
}
}
if decls.isEmpty {
// No declarations to import
return nil
}
return withSpan("Format Import Glue") {
let format = BasicFormat()
return decls.map { $0.formatted(using: format).description }.joined(separator: "\n\n")
}
}
func renderSwiftGlobalGetter(
_ getter: ImportedGetterSkeleton,
topLevelDecls: inout [DeclSyntax]
) throws -> [DeclSyntax] {
let effects = Effects(isAsync: false, isThrows: true)
let builder = try CallJSEmission(
moduleName: moduleName,
abiName: getter.abiName(context: nil),
effects: effects,
returnType: getter.type
)
try builder.call()
try builder.liftReturnValue()
topLevelDecls.append(builder.renderImportDecl())
return [
builder.renderThunkDecl(
name: "_$\(getter.name)_get",
parameters: [],
returnType: getter.type,
effects: effects
)
.with(\.leadingTrivia, Self.renderDocumentation(documentation: getter.documentation))
]
}
class CallJSEmission {
private struct BorrowedArgument {
/// The variable name of the `bridgeJSWithLoweredParameter` return value
let returnVariableName: String?
/// The closure to close the borrowing call
let closeBorrowedClosure: (CodeFragmentPrinter) -> Void
}
let abiName: String
let moduleName: String
let effects: Effects
let returnType: BridgeType
let context: BridgeContext
var body = CodeFragmentPrinter()
var abiParameterForwardings: [String] = []
var abiParameterSignatures: [(name: String, type: WasmCoreType)] = []
let abiReturnType: WasmCoreType?
// Track destructured variable names for multiple lowered parameters
var destructuredVarNames: [String] = []
// Stack-lowered parameters should be evaluated in reverse order to match LIFO stacks
var stackLoweringStmts: [String] = []
// Values to extend lifetime during call
var valuesToExtendLifetimeDuringCall: [String] = []
// Closures to close borrowed parameters
private var borrowedArguments: [BorrowedArgument] = []
private let needsReturnVariable: Bool
init(
moduleName: String,
abiName: String,
effects: Effects,
returnType: BridgeType,
context: BridgeContext = .importTS
) throws {
self.moduleName = moduleName
self.abiName = abiName
self.effects = effects
self.returnType = returnType
self.context = context
let liftingInfo = try returnType.liftingReturnInfo(context: context)
if effects.isAsync || returnType == .void || returnType.usesSideChannelForOptionalReturn()
|| liftingInfo.valueToLift == nil
{
abiReturnType = nil
} else {
abiReturnType = liftingInfo.valueToLift
}
needsReturnVariable = abiReturnType != nil
if effects.isAsync {
prependClosureCallbackParams()
}
}
func lowerParameter(param: Parameter) throws {
let loweringInfo = try param.type.loweringParameterInfo(context: context)
switch param.type {
case .closure(let signature, useJSTypedClosure: false):
let jsTypedClosureType = BridgeType.closure(signature, useJSTypedClosure: true).swiftType
body.write("let \(param.name) = \(jsTypedClosureType)(\(param.name))")
// The just created JSObject is not owned by the caller unlike those passed in parameters,
// so we need to extend its lifetime during the call to ensure the JSObject.id is valid.
valuesToExtendLifetimeDuringCall.append(param.name)
default:
break
}
// Generate destructured variable names for all lowered parameters
let destructuredNames = loweringInfo.loweredParameters.map {
"\(param.name)\($0.name.capitalizedFirstLetter)"
}
// Always add destructuring statement to body (unified for single and multiple)
let pattern: String
if destructuredNames.count == 1 {
pattern = destructuredNames[0]
} else {
pattern = "(" + destructuredNames.joined(separator: ", ") + ")"
}
if loweringInfo.useBorrowing {
let returnVariableName = "ret\(borrowedArguments.count)"
let assign = needsReturnVariable ? "let \(returnVariableName) = " : ""
body.write("\(assign)\(param.name).bridgeJSWithLoweredParameter { \(pattern) in")
body.indent()
borrowedArguments.append(
BorrowedArgument(
returnVariableName: needsReturnVariable ? returnVariableName : nil,
closeBorrowedClosure: { printer in
printer.unindent()
printer.write("}")
}
)
)
} else if case .nullable(.swiftProtocol, _) = param.type, context == .exportSwift {
body.write("let \(pattern): (Int32, Int32)")
body.write("if let \(param.name) {")
body.indent {
body.write(
"\(pattern) = (1, (\(param.name) as! _BridgedSwiftProtocolExportable).bridgeJSLowerAsProtocolReturn())"
)
}
body.write("} else {")
body.indent {
body.write("\(pattern) = (0, 0)")
}
body.write("}")
} else {
let initializerExpr: ExprSyntax
if case .swiftProtocol = param.type, context == .exportSwift {
initializerExpr = ExprSyntax(
"(\(raw: param.name) as! _BridgedSwiftProtocolExportable).bridgeJSLowerAsProtocolReturn()"
)
} else {
initializerExpr = ExprSyntax("\(raw: param.name).bridgeJSLowerParameter()")
}
if loweringInfo.loweredParameters.isEmpty {
stackLoweringStmts.insert("let _ = \(initializerExpr)", at: 0)
return
}
body.write("let \(pattern) = \(initializerExpr)")
}
destructuredVarNames.append(contentsOf: destructuredNames)
// Add to signatures and forwardings (unified for both single and multiple)
for (index, (paramName, type)) in loweringInfo.loweredParameters.enumerated() {
// For single parameter, use param.name; for multiple, use constructed name
let abiParamName: String
if loweringInfo.loweredParameters.count == 1 {
abiParamName = param.name
} else {
abiParamName = "\(param.name)\(paramName.capitalizedFirstLetter)"
}
abiParameterSignatures.append((abiParamName, type))
// Always use destructured variable in call without labels
// Swift allows omitting labels when they match parameter names
abiParameterForwardings.append(destructuredNames[index])
}
}
/// Prepends `resolveRef: Int32, rejectRef: Int32` parameters to the ABI parameter list.
///
/// Used for async imports where the JS side receives closure-backed
/// resolve/reject callbacks as object references.
private func prependClosureCallbackParams() {
abiParameterSignatures.insert(contentsOf: [("resolveRef", .i32), ("rejectRef", .i32)], at: 0)
abiParameterForwardings.insert(contentsOf: ["resolveRef", "rejectRef"], at: 0)
}
func call() throws {
for stmt in stackLoweringStmts {
body.write(stmt.description)
}
let assign = needsReturnVariable ? "let ret = " : ""
var callExpr = "\(abiName)(\(abiParameterForwardings.joined(separator: ", ")))"
if !valuesToExtendLifetimeDuringCall.isEmpty {
callExpr =
"withExtendedLifetime((\(valuesToExtendLifetimeDuringCall.joined(separator: ", ")))) { \(callExpr) }"
}
body.write("\(assign)\(callExpr)")
if let firstBorrowedArgument = borrowedArguments.first {
if needsReturnVariable {
body.write("return ret")
}
for borrowedArgument in borrowedArguments.dropFirst().reversed() {
borrowedArgument.closeBorrowedClosure(body)
if let returnVariableName = borrowedArgument.returnVariableName {
body.write("return \(returnVariableName)")
}
}
firstBorrowedArgument.closeBorrowedClosure(body)
if let returnVariableName = firstBorrowedArgument.returnVariableName {
body.write("let ret = \(returnVariableName)")
}
}
if !effects.isAsync && (context == .importTS || effects.isThrows) {
body.write("if let error = _swift_js_take_exception() { throw error }")
}
}
func liftReturnValue() throws {
if effects.isAsync {
liftAsyncReturnValue()
} else {
try liftSyncReturnValue()
}
}
private func liftSyncReturnValue() throws {
let liftingInfo = try returnType.liftingReturnInfo(context: context)
if returnType == .void {
return
}
if returnType.usesSideChannelForOptionalReturn() {
// Side channel returns: extern function returns Void, value is retrieved via side channel
body.write("return \(returnType.swiftType).bridgeJSLiftReturnFromSideChannel()")
} else {
let liftExpr: String
switch returnType {
case .closure(let signature, _):
liftExpr = "_BJS_Closure_\(signature.mangleName).bridgeJSLift(ret)"
default:
if liftingInfo.valueToLift != nil {
liftExpr = "\(returnType.swiftType).bridgeJSLiftReturn(ret)"
} else {
liftExpr = "\(returnType.swiftType).bridgeJSLiftReturn()"
}
}
body.write("return \(liftExpr)")
}
}
private func liftAsyncReturnValue() {
// For async imports, the extern function takes leading `resolveRef: Int32, rejectRef: Int32`
// and returns void. The JS side calls the resolve/reject closures when the Promise settles.
// The resolve closure is typed to match the return type, so the ABI conversion is handled
// by the existing closure codegen infrastructure — no manual JSValue-to-type switch needed.
// Wrap the existing body (parameter lowering + extern call) in _bjs_awaitPromise
let innerBody = body
body = CodeFragmentPrinter()
let tryKeyword = effects.isThrows ? "try" : "try!"
let rejectFactory = "makeRejectClosure: { JSTypedClosure<(sending JSValue) -> Void>($0) }"
if returnType == .void {
let resolveFactory = "makeResolveClosure: { JSTypedClosure<() -> Void>($0) }"
body.write(
"\(tryKeyword) await _bjs_awaitPromise(\(resolveFactory), \(rejectFactory)) { resolveRef, rejectRef in"
)
} else {
let resolveSwiftType = returnType.closureSwiftType
let resolveFactory =
"makeResolveClosure: { JSTypedClosure<(sending \(resolveSwiftType)) -> Void>($0) }"
body.write(
"let resolved = \(tryKeyword) await _bjs_awaitPromise(\(resolveFactory), \(rejectFactory)) { resolveRef, rejectRef in"
)
}
body.indent {
body.write(lines: innerBody.lines)
}
body.write("}")
if returnType != .void {
body.write("return resolved")
}
}
func renderImportDecl() -> DeclSyntax {
let printer = CodeFragmentPrinter()
SwiftCodePattern.buildExternFunctionDecl(
printer: printer,
moduleName: moduleName,
abiName: abiName,
functionName: abiName,
abiParameters: abiParameterSignatures,
returnType: abiReturnType
)
return "\(raw: printer.lines.joined(separator: "\n"))"
}
func renderThunkDecl(
name: String,
parameters: [Parameter],
returnType: BridgeType,
effects: Effects
) -> DeclSyntax {
let printer = CodeFragmentPrinter()
let signature = SwiftSignatureBuilder.buildFunctionSignature(
parameters: parameters,
returnType: returnType,
effects: effects,
useWildcardLabels: true
)
printer.write("func \(name.backtickIfNeeded())\(signature) {")
printer.indent {
printer.write(lines: body.lines)
}
printer.write("}")
return "\(raw: printer.lines.joined(separator: "\n"))"
}
func renderConstructorDecl(parameters: [Parameter]) -> DeclSyntax {
let printer = CodeFragmentPrinter()
let effects = Effects(isAsync: false, isThrows: true)
let parameterClause = SwiftSignatureBuilder.buildParameterClause(
parameters: parameters,
useWildcardLabels: true
)
let effectSpecifiers = SwiftSignatureBuilder.buildEffectSpecifiers(effects: effects)
printer.write("init\(parameterClause)\(effectSpecifiers.map { " \($0)" } ?? "") {")
printer.indent {
printer.write(lines: body.lines)
}
printer.write("}")
return "\(raw: printer.lines.joined(separator: "\n"))"
}
}
private static func thunkName(function: ImportedFunctionSkeleton) -> String {
"_$\(function.name)"
}
private static func thunkName(type: ImportedTypeSkeleton, method: ImportedFunctionSkeleton) -> String {
"_$\(type.name)_\(method.name)"
}
private static func thunkName(type: ImportedTypeSkeleton) -> String {
"_$\(type.name)_init"
}
private static func thunkName(
type: ImportedTypeSkeleton,
propertyName: String,
operation: String
)
-> String
{
"_$\(type.name)_\(propertyName)_\(operation)"
}
func renderSwiftThunk(
_ function: ImportedFunctionSkeleton,
topLevelDecls: inout [DeclSyntax]
) throws -> [DeclSyntax] {
let builder = try CallJSEmission(
moduleName: moduleName,
abiName: function.abiName(context: nil),
effects: function.effects,
returnType: function.returnType
)
for param in function.parameters {
try builder.lowerParameter(param: param)
}
try builder.call()
try builder.liftReturnValue()
topLevelDecls.append(builder.renderImportDecl())
return [
builder.renderThunkDecl(
name: Self.thunkName(function: function),
parameters: function.parameters,
returnType: function.returnType,
effects: function.effects
)
.with(\.leadingTrivia, Self.renderDocumentation(documentation: function.documentation))
]
}
func renderSwiftType(_ type: ImportedTypeSkeleton, topLevelDecls: inout [DeclSyntax]) throws -> [DeclSyntax] {
let selfParameter = Parameter(label: nil, name: "self", type: .jsObject(nil))
var decls: [DeclSyntax] = []
func renderMethod(method: ImportedFunctionSkeleton) throws -> [DeclSyntax] {
let builder = try CallJSEmission(
moduleName: moduleName,
abiName: method.abiName(context: type),
effects: method.effects,
returnType: method.returnType
)
try builder.lowerParameter(param: selfParameter)
for param in method.parameters {
try builder.lowerParameter(param: param)
}
try builder.call()
try builder.liftReturnValue()
topLevelDecls.append(builder.renderImportDecl())
return [
builder.renderThunkDecl(
name: Self.thunkName(type: type, method: method),
parameters: [selfParameter] + method.parameters,
returnType: method.returnType,
effects: method.effects
)
]
}
func renderStaticMethod(method: ImportedFunctionSkeleton) throws -> [DeclSyntax] {
let abiName = method.abiName(context: type, operation: "static")
let builder = try CallJSEmission(
moduleName: moduleName,
abiName: abiName,
effects: method.effects,
returnType: method.returnType
)
for param in method.parameters {
try builder.lowerParameter(param: param)
}
try builder.call()
try builder.liftReturnValue()
topLevelDecls.append(builder.renderImportDecl())
return [
builder.renderThunkDecl(
name: Self.thunkName(type: type, method: method),
parameters: method.parameters,
returnType: method.returnType,
effects: method.effects
)
]
}
func renderConstructorDecl(constructor: ImportedConstructorSkeleton) throws -> [DeclSyntax] {
let effects = Effects(isAsync: false, isThrows: true)
let builder = try CallJSEmission(
moduleName: moduleName,
abiName: constructor.abiName(context: type),
effects: effects,
returnType: .jsObject(nil)
)
for param in constructor.parameters {
try builder.lowerParameter(param: param)
}
try builder.call()
try builder.liftReturnValue()
topLevelDecls.append(builder.renderImportDecl())
return [
builder.renderThunkDecl(
name: Self.thunkName(type: type),
parameters: constructor.parameters,
returnType: .jsObject(nil),
effects: effects
)
]
}
func renderGetterDecl(getter: ImportedGetterSkeleton) throws -> DeclSyntax {
let effects = Effects(isAsync: false, isThrows: true)
let builder = try CallJSEmission(
moduleName: moduleName,
abiName: getter.abiName(context: type),
effects: effects,
returnType: getter.type
)
try builder.lowerParameter(param: selfParameter)
try builder.call()
try builder.liftReturnValue()
topLevelDecls.append(builder.renderImportDecl())
return DeclSyntax(
builder.renderThunkDecl(
name: Self.thunkName(type: type, propertyName: getter.name, operation: "get"),
parameters: [selfParameter],
returnType: getter.type,
effects: effects
)
)
}
func renderSetterDecl(setter: ImportedSetterSkeleton) throws -> DeclSyntax {
let effects = Effects(isAsync: false, isThrows: true)
let builder = try CallJSEmission(
moduleName: moduleName,
abiName: setter.abiName(context: type),
effects: effects,
returnType: .void
)
let newValue = Parameter(label: nil, name: "newValue", type: setter.type)
try builder.lowerParameter(param: selfParameter)
try builder.lowerParameter(param: newValue)
try builder.call()
topLevelDecls.append(builder.renderImportDecl())
// Use functionName if available (has lowercase first char), otherwise derive from name
let propertyNameForThunk: String
if let functionName = setter.functionName, functionName.hasSuffix("_set") {
// Extract base name from functionName (e.g., "any_set" -> "any")
propertyNameForThunk = String(functionName.dropLast(4))
} else {
// Lowercase first character of property name for thunk
propertyNameForThunk = setter.name.prefix(1).lowercased() + setter.name.dropFirst()
}
return builder.renderThunkDecl(
name: Self.thunkName(type: type, propertyName: propertyNameForThunk, operation: "set"),
parameters: [selfParameter, newValue],
returnType: .void,
effects: effects
)
}
if let constructor = type.constructor {
decls.append(contentsOf: try renderConstructorDecl(constructor: constructor))
}
for method in type.staticMethods {
decls.append(contentsOf: try renderStaticMethod(method: method))
}
for getter in type.getters {
decls.append(try renderGetterDecl(getter: getter))
}
for setter in type.setters {
decls.append(try renderSetterDecl(setter: setter))
}
for method in type.methods {
decls.append(contentsOf: try renderMethod(method: method))
}
return decls
}
static func renderDocumentation(documentation: String?) -> Trivia {
guard let documentation = documentation else {
return Trivia()
}
let lines = documentation.split { $0.isNewline }
return Trivia(pieces: lines.flatMap { [TriviaPiece.docLineComment("/// \($0)"), .newlines(1)] })
}
static func buildAccessorEffect(throws: Bool, async: Bool) -> AccessorEffectSpecifiersSyntax {
return AccessorEffectSpecifiersSyntax(
asyncSpecifier: `async` ? .keyword(.async) : nil,
throwsClause: `throws`
? ThrowsClauseSyntax(
throwsSpecifier: .keyword(.throws),
leftParen: .leftParenToken(),
type: IdentifierTypeSyntax(name: .identifier("JSException")),
rightParen: .rightParenToken()
) : nil
)
}
}
/// Unified utility for building Swift function signatures using SwiftSyntax
///
/// This struct eliminates code duplication by providing a single source of truth
/// for generating Swift function signatures across ImportTS, ExportSwift, and
/// other code generators.
struct SwiftSignatureBuilder {
/// Builds a complete function signature from parameters, return type, and effects
///
/// - Parameters:
/// - parameters: Array of Parameter structs for Swift function signatures
/// - returnType: The return type of the function
/// - effects: Optional effects (async/throws)
/// - Returns: A FunctionSignatureSyntax node
static func buildFunctionSignature(
parameters: [Parameter],
returnType: BridgeType,
effects: Effects? = nil,
useWildcardLabels: Bool = false
) -> String {
let parameterClause = buildParameterClause(parameters: parameters, useWildcardLabels: useWildcardLabels)
let effectSpecifiers = effects.flatMap { buildEffectSpecifiers(effects: $0) }
let returnClause = buildReturnClause(returnType: returnType)
var out = ""
out += parameterClause
if let effectSpecifiers {
out += " \(effectSpecifiers)"
}
out += returnClause
return out
}
/// Builds a function signature for ABI/extern functions using WasmCoreType parameters
///
/// - Parameters:
/// - abiParameters: Array of (name, WasmCoreType) tuples for ABI signatures
/// - returnType: The return type as WasmCoreType (nil for Void)
/// - effects: Optional effects (async/throws)
/// - Returns: A FunctionSignatureSyntax node
static func buildABIFunctionSignature(
abiParameters: [(name: String, type: WasmCoreType)],
returnType: WasmCoreType?,
effects: Effects? = nil
) -> String {
var out = ""
out += buildABIParameterClause(abiParameters: abiParameters)
if let effects = effects, let effectSpecifiers = buildEffectSpecifiers(effects: effects) {
out += " \(effectSpecifiers)"
}
out += buildABIReturnClause(returnType: returnType)
return out
}
/// Builds a parameter clause from an array of Parameter structs
///
/// - Parameters:
/// - parameters: Array of Parameter structs
/// - useWildcardLabels: If true, all parameters use wildcard labels ("_ name: Type").
/// If false, handles parameter labels:
/// - If label == name: single identifier (e.g., "count: Int")
/// - If label != name: labeled parameter (e.g., "label count: Int")
/// - If label == nil: wildcard label (e.g., "_ count: Int")
static func buildParameterClause(
parameters: [Parameter],
useWildcardLabels: Bool = false
) -> String {
var out = "("
out += parameters.map { param in
let label = param.label ?? param.name
let paramType = buildParameterTypeSyntax(from: param.type)
if useWildcardLabels {
// Always use wildcard labels: "_ name: Type"
return "_ \(param.name): \(paramType)"
} else if label == param.name {
// External label same as parameter name: "count: Int"
return "\(param.name): \(paramType)"
} else if param.label == nil {
// No label specified: use wildcard "_ name: Type"
return "_ \(param.name): \(paramType)"
} else {
// External label differs: "label count: Int"
return "\(label) \(param.name): \(paramType)"
}
}.joined(separator: ", ")
out += ")"
return out
}
/// Builds a parameter clause for ABI/extern functions
///
/// All parameters use wildcard labels: "_ name: Type"
static func buildABIParameterClause(
abiParameters: [(name: String, type: WasmCoreType)]
) -> String {
"("
+ abiParameters.map { param in
"_ \(param.name): \(param.type.swiftType)"
}.joined(separator: ", ") + ")"
}
/// Builds a return clause from a BridgeType
///
/// Always returns a ReturnClauseSyntax, including for Void types
/// (to match original behavior that explicitly includes "-> Void")
static func buildReturnClause(returnType: BridgeType) -> String {
return " -> \(returnType.swiftType)"
}
/// Builds a return clause for ABI/extern functions
///
/// Returns nil for Void (when returnType is nil), otherwise returns a ReturnClauseSyntax
static func buildABIReturnClause(returnType: WasmCoreType?) -> String {
guard let returnType = returnType else {
return " -> Void"
}
return " -> \(returnType.swiftType)"
}
/// Builds effect specifiers (async/throws) from an Effects struct
///
/// Uses JSException as the thrown error type for throws clauses
static func buildEffectSpecifiers(effects: Effects) -> String? {
guard effects.isAsync || effects.isThrows else {
return nil
}
var items: [String] = []
if effects.isAsync { items.append("async") }
if effects.isThrows { items.append("throws(JSException)") }
return items.joined(separator: " ")
}
/// Builds a TypeSyntax node from a BridgeType
///
/// Converts BridgeType to its Swift type representation as a TypeSyntax node
static func buildTypeSyntax(from type: BridgeType) -> String {
return type.swiftType
}
/// Builds a parameter type syntax from a BridgeType.
static func buildParameterTypeSyntax(from type: BridgeType) -> String {
switch type {
case .closure(_, useJSTypedClosure: false):
return "@escaping \(type.swiftType)"
default:
return buildTypeSyntax(from: type)
}
}
}
enum SwiftCodePattern {
/// Builds a conditional compilation block with #if arch(wasm32) and #else fatalError
static func buildWasmConditionalCompilation(
printer: CodeFragmentPrinter,
wasmBody: (_ printer: CodeFragmentPrinter) -> Void
) {
printer.write("#if arch(wasm32)")
wasmBody(printer)
printer.write("#else")
printer.write("fatalError(\"Only available on WebAssembly\")")
printer.write("#endif")
}
/// Builds a conditional compilation block with #if arch(wasm32) and #else for declarations
static func buildWasmConditionalCompilationDecls(
printer: CodeFragmentPrinter,
wasmDecl: (_ printer: CodeFragmentPrinter) -> Void,
elseDecl: (_ printer: CodeFragmentPrinter) -> Void
) {
printer.write("#if arch(wasm32)")
wasmDecl(printer)
printer.write("#else")
elseDecl(printer)
printer.write("#endif")
}
static func buildExternFunctionDecl(
printer: CodeFragmentPrinter,
moduleName: String,
abiName: String,
functionName: String,
abiParameters: [(name: String, type: WasmCoreType)],
returnType: WasmCoreType?
) {
let signature = SwiftSignatureBuilder.buildABIFunctionSignature(
abiParameters: abiParameters,
returnType: returnType
)
buildExternFunctionDecl(
printer: printer,
moduleName: moduleName,
abiName: abiName,
functionName: functionName,
signature: signature,
parameterNames: abiParameters.map { $0.name }
)
}
/// Builds the @_extern attribute for WebAssembly extern function declarations
/// Builds an @_extern function declaration (no body, just the declaration)
static func buildExternFunctionDecl(
printer: CodeFragmentPrinter,
moduleName: String,
abiName: String,
functionName: String,
signature: String,
parameterNames: [String],
) {
// NOTE: Due to a Swift compiler issue, we can't declare possibly inlined functions as @_extern
// https://github.com/swiftlang/swift/pull/87250
let inModuleDeclName = "\(functionName)_extern"
buildWasmConditionalCompilationDecls(
printer: printer,
wasmDecl: { printer in
printer.write(buildExternAttribute(moduleName: moduleName, abiName: abiName))
printer.write("fileprivate func \(inModuleDeclName)\(signature)")
},
elseDecl: { printer in
printer.write("fileprivate func \(inModuleDeclName)\(signature) {")
printer.indent {
printer.write("fatalError(\"Only available on WebAssembly\")")
}
printer.write("}")
}
)
printer.write("@inline(never) fileprivate func \(functionName)\(signature) {")
printer.indent {
printer.write("return \(inModuleDeclName)(\(parameterNames.joined(separator: ", ")))")
}
printer.write("}")
}
/// Builds the standard @_expose and @_cdecl attributes for WebAssembly-exposed functions
static func buildExposeAttributes(abiName: String) -> String {
return """
@_expose(wasm, "\(abiName)")
@_cdecl("\(abiName)")
"""
}
/// Builds a function declaration with @_expose/@_cdecl attributes and conditional compilation
static func buildExposedFunctionDecl(
abiName: String,
signature: String,
body: (CodeFragmentPrinter) -> Void
) -> DeclSyntax {
let printer = CodeFragmentPrinter()
printer.write(buildExposeAttributes(abiName: abiName))
printer.write("public func _\(abiName)\(signature) {")
printer.indent {
buildWasmConditionalCompilation(printer: printer, wasmBody: body)
}
printer.write("}")
return "\(raw: printer.lines.joined(separator: "\n"))"
}
/// Builds the @_extern attribute for WebAssembly extern function declarations
static func buildExternAttribute(moduleName: String, abiName: String) -> String {
return "@_extern(wasm, module: \"\(moduleName)\", name: \"\(abiName)\")"
}
}
extension BridgeType {
struct LoweringParameterInfo {
let loweredParameters: [(name: String, type: WasmCoreType)]
/// If true, the parameter should be lowered by using `bridgeJSWithLoweredParameter`
/// that takes a closure to handle the borrowed parameter.
var useBorrowing: Bool = false
static let bool = LoweringParameterInfo(loweredParameters: [("value", .i32)])
static let int = LoweringParameterInfo(loweredParameters: [("value", .i32)])
static let float = LoweringParameterInfo(loweredParameters: [("value", .f32)])
static let double = LoweringParameterInfo(loweredParameters: [("value", .f64)])
static let string = LoweringParameterInfo(
loweredParameters: [("bytes", .i32), ("length", .i32)],
useBorrowing: true
)
static let jsObject = LoweringParameterInfo(loweredParameters: [("value", .i32)])
static let jsValue = LoweringParameterInfo(loweredParameters: [
("kind", .i32),
("payload1", .i32),
("payload2", .f64),
])
static let void = LoweringParameterInfo(loweredParameters: [])
}
func loweringParameterInfo(context: BridgeContext = .importTS) throws -> LoweringParameterInfo {
switch self {
case .bool: return .bool
case .integer(let t): return LoweringParameterInfo(loweredParameters: [("value", t.wasmCoreType)])
case .float: return .float
case .double: return .double
case .string: return .string
case .jsObject: return .jsObject
case .jsValue: return .jsValue
case .void: return .void
case .closure:
// Swift closure is passed to JS as a JS function reference.
return LoweringParameterInfo(loweredParameters: [("funcRef", .i32)])
case .unsafePointer:
return LoweringParameterInfo(loweredParameters: [("pointer", .pointer)])
case .swiftHeapObject:
return LoweringParameterInfo(loweredParameters: [("pointer", .pointer)])
case .swiftProtocol:
switch context {
case .importTS:
throw BridgeJSCoreError("swiftProtocol is not supported in imported signatures")
case .exportSwift:
return LoweringParameterInfo(loweredParameters: [("objectId", .i32)])
}
case .caseEnum:
return LoweringParameterInfo(loweredParameters: [("value", .i32)])
case .rawValueEnum(_, let rawType):
if rawType == .string {
return .string
}
let wasmType = rawType.wasmCoreType ?? .i32
return LoweringParameterInfo(loweredParameters: [("value", wasmType)])
case .associatedValueEnum:
switch context {
case .importTS:
throw BridgeJSCoreError("Enum types are not yet supported in TypeScript imports")
case .exportSwift:
return LoweringParameterInfo(loweredParameters: [("caseId", .i32)])
}
case .swiftStruct:
switch context {
case .importTS:
// Swift structs are bridged as JS objects (object IDs) in imported signatures.
return LoweringParameterInfo(loweredParameters: [("objectId", .i32)])
case .exportSwift:
return LoweringParameterInfo(loweredParameters: [])
}
case .namespaceEnum:
throw BridgeJSCoreError("Namespace enums cannot be used as parameters")
case .nullable(.swiftStruct, _) where context == .importTS:
// Optional `@JS struct`s bridge through the stack (isSome discriminator + fields),
// like optional arrays/dictionaries, rather than the non-optional object-id ABI.
return LoweringParameterInfo(loweredParameters: [("isSome", .i32)])
case .nullable(let wrappedType, _):
let wrappedInfo = try wrappedType.loweringParameterInfo(context: context)
var params = [("isSome", WasmCoreType.i32)]
params.append(contentsOf: wrappedInfo.loweredParameters)
return LoweringParameterInfo(loweredParameters: params, useBorrowing: wrappedInfo.useBorrowing)
case .array, .dictionary:
return LoweringParameterInfo(loweredParameters: [])
}
}
struct LiftingReturnInfo {
let valueToLift: WasmCoreType?
static let bool = LiftingReturnInfo(valueToLift: .i32)
static let int = LiftingReturnInfo(valueToLift: .i32)
static let float = LiftingReturnInfo(valueToLift: .f32)
static let double = LiftingReturnInfo(valueToLift: .f64)
static let string = LiftingReturnInfo(valueToLift: .i32)
static let jsObject = LiftingReturnInfo(valueToLift: .i32)
static let jsValue = LiftingReturnInfo(valueToLift: nil)
static let void = LiftingReturnInfo(valueToLift: nil)
}
func liftingReturnInfo(
context: BridgeContext = .importTS
) throws -> LiftingReturnInfo {
switch self {
case .bool: return .bool
case .integer(let t): return LiftingReturnInfo(valueToLift: t.wasmCoreType)
case .float: return .float
case .double: return .double
case .string: return .string
case .jsObject: return .jsObject
case .jsValue: return .jsValue
case .void: return .void
case .closure:
// JS returns a callback ID for closures, which Swift lifts to a typed closure.
return LiftingReturnInfo(valueToLift: .i32)
case .unsafePointer:
return LiftingReturnInfo(valueToLift: .pointer)
case .swiftHeapObject:
return LiftingReturnInfo(valueToLift: .pointer)
case .swiftProtocol: