Skip to content

Commit d79a9be

Browse files
krodakkrodak
authored
Merge pull request #527 from swiftwasm/katei/7d0c-add-init-unsafel
BridgeJS: add init(unsafelyCopying:) for @js structs
2 parents 89e3532 + da51c40 commit d79a9be

File tree

57 files changed

+2023
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+2023
-3
lines changed

‎Benchmarks/Sources/Generated/BridgeJS.swift‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,49 @@ extension SimpleStruct: _BridgedSwiftStruct {
267267
_swift_js_push_f32(self.rate)
268268
_swift_js_push_f64(self.precise)
269269
}
270+
271+
init(unsafelyCopying jsObject: JSObject) {
272+
let __bjs_cleanupId = _SimpleStructHelpers.lower(jsObject)
273+
defer {
274+
_swift_js_struct_cleanup(__bjs_cleanupId)
275+
}
276+
self = Self.bridgeJSLiftParameter()
277+
}
278+
279+
func toJSObject() -> JSObject {
280+
var __bjs_self = self
281+
__bjs_self.bridgeJSLowerReturn()
282+
return _SimpleStructHelpers.raise()
283+
}
284+
}
285+
286+
fileprivate enum _SimpleStructHelpers {
287+
static func lower(_ jsObject: JSObject) -> Int32 {
288+
return _bjs_struct_lower_SimpleStruct(jsObject.bridgeJSLowerParameter())
289+
}
290+
291+
static func raise() -> JSObject {
292+
return JSObject(id: UInt32(bitPattern: _bjs_struct_raise_SimpleStruct()))
293+
}
294+
}
295+
296+
#if arch(wasm32)
297+
@_extern(wasm, module: "bjs", name: "swift_js_struct_lower_SimpleStruct")
298+
fileprivate func _bjs_struct_lower_SimpleStruct(_ objectId: Int32) -> Int32
299+
#else
300+
fileprivate func _bjs_struct_lower_SimpleStruct(_ objectId: Int32) -> Int32 {
301+
fatalError("Only available on WebAssembly")
270302
}
303+
#endif
304+
305+
#if arch(wasm32)
306+
@_extern(wasm, module: "bjs", name: "swift_js_struct_raise_SimpleStruct")
307+
fileprivate func _bjs_struct_raise_SimpleStruct() -> Int32
308+
#else
309+
fileprivate func _bjs_struct_raise_SimpleStruct() -> Int32 {
310+
fatalError("Only available on WebAssembly")
311+
}
312+
#endif
271313

272314
extension Address: _BridgedSwiftStruct {
273315
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter() -> Address {
@@ -288,7 +330,49 @@ extension Address: _BridgedSwiftStruct {
288330
}
289331
_swift_js_push_int(Int32(self.zipCode))
290332
}
333+
334+
init(unsafelyCopying jsObject: JSObject) {
335+
let __bjs_cleanupId = _AddressHelpers.lower(jsObject)
336+
defer {
337+
_swift_js_struct_cleanup(__bjs_cleanupId)
338+
}
339+
self = Self.bridgeJSLiftParameter()
340+
}
341+
342+
func toJSObject() -> JSObject {
343+
var __bjs_self = self
344+
__bjs_self.bridgeJSLowerReturn()
345+
return _AddressHelpers.raise()
346+
}
347+
}
348+
349+
fileprivate enum _AddressHelpers {
350+
static func lower(_ jsObject: JSObject) -> Int32 {
351+
return _bjs_struct_lower_Address(jsObject.bridgeJSLowerParameter())
352+
}
353+
354+
static func raise() -> JSObject {
355+
return JSObject(id: UInt32(bitPattern: _bjs_struct_raise_Address()))
356+
}
357+
}
358+
359+
#if arch(wasm32)
360+
@_extern(wasm, module: "bjs", name: "swift_js_struct_lower_Address")
361+
fileprivate func _bjs_struct_lower_Address(_ objectId: Int32) -> Int32
362+
#else
363+
fileprivate func _bjs_struct_lower_Address(_ objectId: Int32) -> Int32 {
364+
fatalError("Only available on WebAssembly")
291365
}
366+
#endif
367+
368+
#if arch(wasm32)
369+
@_extern(wasm, module: "bjs", name: "swift_js_struct_raise_Address")
370+
fileprivate func _bjs_struct_raise_Address() -> Int32
371+
#else
372+
fileprivate func _bjs_struct_raise_Address() -> Int32 {
373+
fatalError("Only available on WebAssembly")
374+
}
375+
#endif
292376

293377
extension Person: _BridgedSwiftStruct {
294378
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter() -> Person {
@@ -315,7 +399,49 @@ extension Person: _BridgedSwiftStruct {
315399
}
316400
_swift_js_push_int(__bjs_isSome_email ? 1 : 0)
317401
}
402+
403+
init(unsafelyCopying jsObject: JSObject) {
404+
let __bjs_cleanupId = _PersonHelpers.lower(jsObject)
405+
defer {
406+
_swift_js_struct_cleanup(__bjs_cleanupId)
407+
}
408+
self = Self.bridgeJSLiftParameter()
409+
}
410+
411+
func toJSObject() -> JSObject {
412+
var __bjs_self = self
413+
__bjs_self.bridgeJSLowerReturn()
414+
return _PersonHelpers.raise()
415+
}
416+
}
417+
418+
fileprivate enum _PersonHelpers {
419+
static func lower(_ jsObject: JSObject) -> Int32 {
420+
return _bjs_struct_lower_Person(jsObject.bridgeJSLowerParameter())
421+
}
422+
423+
static func raise() -> JSObject {
424+
return JSObject(id: UInt32(bitPattern: _bjs_struct_raise_Person()))
425+
}
426+
}
427+
428+
#if arch(wasm32)
429+
@_extern(wasm, module: "bjs", name: "swift_js_struct_lower_Person")
430+
fileprivate func _bjs_struct_lower_Person(_ objectId: Int32) -> Int32
431+
#else
432+
fileprivate func _bjs_struct_lower_Person(_ objectId: Int32) -> Int32 {
433+
fatalError("Only available on WebAssembly")
318434
}
435+
#endif
436+
437+
#if arch(wasm32)
438+
@_extern(wasm, module: "bjs", name: "swift_js_struct_raise_Person")
439+
fileprivate func _bjs_struct_raise_Person() -> Int32
440+
#else
441+
fileprivate func _bjs_struct_raise_Person() -> Int32 {
442+
fatalError("Only available on WebAssembly")
443+
}
444+
#endif
319445

320446
extension ComplexStruct: _BridgedSwiftStruct {
321447
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter() -> ComplexStruct {
@@ -345,7 +471,49 @@ extension ComplexStruct: _BridgedSwiftStruct {
345471
_swift_js_push_string(ptr.baseAddress, Int32(ptr.count))
346472
}
347473
}
474+
475+
init(unsafelyCopying jsObject: JSObject) {
476+
let __bjs_cleanupId = _ComplexStructHelpers.lower(jsObject)
477+
defer {
478+
_swift_js_struct_cleanup(__bjs_cleanupId)
479+
}
480+
self = Self.bridgeJSLiftParameter()
481+
}
482+
483+
func toJSObject() -> JSObject {
484+
var __bjs_self = self
485+
__bjs_self.bridgeJSLowerReturn()
486+
return _ComplexStructHelpers.raise()
487+
}
488+
}
489+
490+
fileprivate enum _ComplexStructHelpers {
491+
static func lower(_ jsObject: JSObject) -> Int32 {
492+
return _bjs_struct_lower_ComplexStruct(jsObject.bridgeJSLowerParameter())
493+
}
494+
495+
static func raise() -> JSObject {
496+
return JSObject(id: UInt32(bitPattern: _bjs_struct_raise_ComplexStruct()))
497+
}
498+
}
499+
500+
#if arch(wasm32)
501+
@_extern(wasm, module: "bjs", name: "swift_js_struct_lower_ComplexStruct")
502+
fileprivate func _bjs_struct_lower_ComplexStruct(_ objectId: Int32) -> Int32
503+
#else
504+
fileprivate func _bjs_struct_lower_ComplexStruct(_ objectId: Int32) -> Int32 {
505+
fatalError("Only available on WebAssembly")
348506
}
507+
#endif
508+
509+
#if arch(wasm32)
510+
@_extern(wasm, module: "bjs", name: "swift_js_struct_raise_ComplexStruct")
511+
fileprivate func _bjs_struct_raise_ComplexStruct() -> Int32
512+
#else
513+
fileprivate func _bjs_struct_raise_ComplexStruct() -> Int32 {
514+
fatalError("Only available on WebAssembly")
515+
}
516+
#endif
349517

350518
@_expose(wasm, "bjs_run")
351519
@_cdecl("bjs_run")

‎Plugins/BridgeJS/Sources/BridgeJSCore/ExportSwift.swift‎

Lines changed: 85 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public class ExportSwift {
7474

7575
let structCodegen = StructCodegen()
7676
for structDef in skeleton.structs {
77-
decls.append(structCodegen.renderStructHelpers(structDef))
77+
decls.append(contentsOf: structCodegen.renderStructHelpers(structDef))
7878
decls.append(contentsOf: try renderSingleExportedStruct(struct: structDef))
7979
}
8080

@@ -1151,12 +1151,19 @@ struct EnumCodegen {
11511151
struct StructCodegen {
11521152
private let stackCodegen = StackCodegen()
11531153

1154-
func renderStructHelpers(_ structDef: ExportedStruct) -> DeclSyntax {
1154+
func renderStructHelpers(_ structDef: ExportedStruct) -> [DeclSyntax] {
11551155
let typeName = structDef.swiftCallName
11561156
let liftCode = generateStructLiftCode(structDef: structDef)
11571157
let lowerCode = generateStructLowerCode(structDef: structDef)
1158+
let accessControl = structDef.explicitAccessControl.map { "\($0) " } ?? ""
11581159

1159-
return """
1160+
let helpersTypeName = "_\(structDef.name)Helpers"
1161+
let lowerExternName = "swift_js_struct_lower_\(structDef.name)"
1162+
let raiseExternName = "swift_js_struct_raise_\(structDef.name)"
1163+
let lowerFunctionName = "_bjs_struct_lower_\(structDef.name)"
1164+
let raiseFunctionName = "_bjs_struct_raise_\(structDef.name)"
1165+
1166+
let bridgedStructExtension: DeclSyntax = """
11601167
extension \(raw: typeName): _BridgedSwiftStruct {
11611168
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter() -> \(raw: typeName) {
11621169
\(raw: liftCode.joined(separator: "\n"))
@@ -1165,8 +1172,83 @@ struct StructCodegen {
11651172
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerReturn() {
11661173
\(raw: lowerCode.joined(separator: "\n"))
11671174
}
1175+
1176+
\(raw: accessControl)init(unsafelyCopying jsObject: JSObject) {
1177+
let __bjs_cleanupId = \(raw: helpersTypeName).lower(jsObject)
1178+
defer { _swift_js_struct_cleanup(__bjs_cleanupId) }
1179+
self = Self.bridgeJSLiftParameter()
1180+
}
1181+
1182+
\(raw: accessControl)func toJSObject() -> JSObject {
1183+
var __bjs_self = self
1184+
__bjs_self.bridgeJSLowerReturn()
1185+
return \(raw: helpersTypeName).raise()
1186+
}
11681187
}
11691188
"""
1189+
1190+
let helpersType: DeclSyntax = """
1191+
fileprivate enum \(raw: helpersTypeName) {
1192+
static func lower(_ jsObject: JSObject) -> Int32 {
1193+
return \(raw: lowerFunctionName)(jsObject.bridgeJSLowerParameter())
1194+
}
1195+
1196+
static func raise() -> JSObject {
1197+
return JSObject(id: UInt32(bitPattern: \(raw: raiseFunctionName)()))
1198+
}
1199+
}
1200+
"""
1201+
1202+
let lowerExternDecl = Self.renderStructExtern(
1203+
externName: lowerExternName,
1204+
functionName: lowerFunctionName,
1205+
signature: SwiftSignatureBuilder.buildABIFunctionSignature(
1206+
abiParameters: [("objectId", .i32)],
1207+
returnType: .i32
1208+
)
1209+
)
1210+
let raiseExternDecl = Self.renderStructExtern(
1211+
externName: raiseExternName,
1212+
functionName: raiseFunctionName,
1213+
signature: SwiftSignatureBuilder.buildABIFunctionSignature(
1214+
abiParameters: [],
1215+
returnType: .i32
1216+
)
1217+
)
1218+
1219+
return [bridgedStructExtension, helpersType, lowerExternDecl, raiseExternDecl]
1220+
}
1221+
1222+
private static func renderStructExtern(
1223+
externName: String,
1224+
functionName: String,
1225+
signature: FunctionSignatureSyntax
1226+
) -> DeclSyntax {
1227+
let externFuncDecl = SwiftCodePattern.buildExternFunctionDecl(
1228+
moduleName: "bjs",
1229+
abiName: externName,
1230+
functionName: functionName,
1231+
signature: signature
1232+
)
1233+
1234+
let stubFuncDecl = FunctionDeclSyntax(
1235+
modifiers: DeclModifierListSyntax {
1236+
DeclModifierSyntax(name: .keyword(.fileprivate))
1237+
},
1238+
funcKeyword: .keyword(.func),
1239+
name: .identifier(functionName),
1240+
signature: signature,
1241+
body: CodeBlockSyntax {
1242+
"fatalError(\"Only available on WebAssembly\")"
1243+
}
1244+
)
1245+
1246+
return DeclSyntax(
1247+
SwiftCodePattern.buildWasmConditionalCompilationDecls(
1248+
wasmDecl: DeclSyntax(externFuncDecl),
1249+
elseDecl: DeclSyntax(stubFuncDecl)
1250+
)
1251+
)
11701252
}
11711253

11721254
private func generateStructLiftCode(structDef: ExportedStruct) -> [String] {

‎Plugins/BridgeJS/Sources/BridgeJSLink/BridgeJSLink.swift‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,7 @@ public struct BridgeJSLink {
245245
"let \(JSGlueVariableScope.reservedTmpParamF64s) = [];",
246246
"let \(JSGlueVariableScope.reservedTmpRetPointers) = [];",
247247
"let \(JSGlueVariableScope.reservedTmpParamPointers) = [];",
248+
"let \(JSGlueVariableScope.reservedTmpStructCleanups) = [];",
248249
"const \(JSGlueVariableScope.reservedEnumHelpers) = {};",
249250
"const \(JSGlueVariableScope.reservedStructHelpers) = {};",
250251
"",
@@ -295,6 +296,7 @@ public struct BridgeJSLink {
295296

296297
private func generateAddImports() -> CodeFragmentPrinter {
297298
let printer = CodeFragmentPrinter()
299+
let allStructs = skeletons.compactMap { $0.exported?.structs }.flatMap { $0 }
298300
printer.write("return {")
299301
printer.indent {
300302
printer.write(lines: [
@@ -427,6 +429,53 @@ public struct BridgeJSLink {
427429
printer.write("return \(JSGlueVariableScope.reservedTmpParamPointers).pop();")
428430
}
429431
printer.write("}")
432+
433+
printer.write("bjs[\"swift_js_struct_cleanup\"] = function(cleanupId) {")
434+
printer.indent {
435+
printer.write("if (cleanupId === 0) { return; }")
436+
printer.write("const index = (cleanupId | 0) - 1;")
437+
printer.write("const cleanup = \(JSGlueVariableScope.reservedTmpStructCleanups)[index];")
438+
printer.write("\(JSGlueVariableScope.reservedTmpStructCleanups)[index] = null;")
439+
printer.write("if (cleanup) { cleanup(); }")
440+
printer.write(
441+
"while (\(JSGlueVariableScope.reservedTmpStructCleanups).length > 0 && \(JSGlueVariableScope.reservedTmpStructCleanups)[\(JSGlueVariableScope.reservedTmpStructCleanups).length - 1] == null) {"
442+
)
443+
printer.indent {
444+
printer.write("\(JSGlueVariableScope.reservedTmpStructCleanups).pop();")
445+
}
446+
printer.write("}")
447+
}
448+
printer.write("}")
449+
450+
if !allStructs.isEmpty {
451+
for structDef in allStructs {
452+
printer.write("bjs[\"swift_js_struct_lower_\(structDef.name)\"] = function(objectId) {")
453+
printer.indent {
454+
printer.write(
455+
"const { cleanup: cleanup } = \(JSGlueVariableScope.reservedStructHelpers).\(structDef.name).lower(\(JSGlueVariableScope.reservedSwift).memory.getObject(objectId));"
456+
)
457+
printer.write("if (cleanup) {")
458+
printer.indent {
459+
printer.write(
460+
"return \(JSGlueVariableScope.reservedTmpStructCleanups).push(cleanup);"
461+
)
462+
}
463+
printer.write("}")
464+
printer.write("return 0;")
465+
}
466+
printer.write("}")
467+
468+
printer.write("bjs[\"swift_js_struct_raise_\(structDef.name)\"] = function() {")
469+
printer.indent {
470+
printer.write(
471+
"const value = \(JSGlueVariableScope.reservedStructHelpers).\(structDef.name).raise(\(JSGlueVariableScope.reservedTmpRetStrings), \(JSGlueVariableScope.reservedTmpRetInts), \(JSGlueVariableScope.reservedTmpRetF32s), \(JSGlueVariableScope.reservedTmpRetF64s), \(JSGlueVariableScope.reservedTmpRetPointers));"
472+
)
473+
printer.write("return \(JSGlueVariableScope.reservedSwift).memory.retain(value);")
474+
}
475+
printer.write("}")
476+
}
477+
}
478+
430479
printer.write("bjs[\"swift_js_return_optional_bool\"] = function(isSome, value) {")
431480
printer.indent {
432481
printer.write("if (isSome === 0) {")

0 commit comments

Comments
 (0)