forked from swiftwasm/JavaScriptKit
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathBridgeJSIntrinsics.swift
More file actions
1998 lines (1766 loc) · 72.4 KB
/
BridgeJSIntrinsics.swift
File metadata and controls
1998 lines (1766 loc) · 72.4 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
/// BridgeJS Intrinsics
///
/// This file contains low-level intrinsic functions that are used by code generated
/// by the BridgeJS system.
import _CJavaScriptKit
#if !arch(wasm32)
@usableFromInline func _onlyAvailableOnWasm() -> Never {
fatalError("Only available on WebAssembly")
}
#endif
// MARK: Exception Handling
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_throw")
private func _swift_js_throw_extern(_ id: Int32)
#else
private func _swift_js_throw_extern(_ id: Int32) {
_onlyAvailableOnWasm()
}
#endif
/// Throws a JavaScript exception from Swift code.
///
/// This function is called by the BridgeJS code generator when a Swift function throws
/// an error. The exception object is retained and stored for later retrieval by the
/// JavaScript-side runtime code.
///
/// - Parameter id: The ID of the JavaScript exception object to throw
@_spi(BridgeJS) @inline(never) public func _swift_js_throw(_ id: Int32) {
_swift_js_throw_extern(id)
}
/// Retrieves and clears any pending JavaScript exception.
///
/// This function checks for any JavaScript exceptions that were thrown during
/// the execution of imported JavaScript functions. If an exception exists, it
/// is retrieved, cleared from the global storage, and returned as a `JSException`.
///
/// - Returns: A `JSException` if an exception was pending, `nil` otherwise
@_spi(BridgeJS) @_transparent public func _swift_js_take_exception() -> JSException? {
#if arch(wasm32)
let value = _swift_js_exception_get()
if _fastPath(value == 0) {
return nil
}
_swift_js_exception_set(0)
return JSException(JSObject(id: UInt32(bitPattern: value)).jsValue)
#else
_onlyAvailableOnWasm()
#endif
}
/// Releases a Swift closure from the FinalizationRegistry
///
/// This function is called by the BridgeJS code generator when a Swift closure is released.
/// The closure is released from the FinalizationRegistry so it can be garbage collected to
/// balance the
///
/// - Parameter pointer: The pointer to `_BridgeJSTypedClosureBox` instance
@_expose(wasm, "bjs_release_swift_closure")
public func _bjs_release_swift_closure(_ pointer: UnsafeMutableRawPointer) {
Unmanaged<AnyObject>.fromOpaque(pointer).release()
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_closure_unregister")
private func _swift_js_closure_unregister_extern(_ id: Int32)
#else
private func _swift_js_closure_unregister_extern(_ id: Int32) {
_onlyAvailableOnWasm()
}
#endif
/// Unregisters a Swift closure from the FinalizationRegistry
///
/// - Parameter id: The JavaScriptObjectRef of the JS closure object created by
/// the BridgeJS's `make_swift_closure_{signature}` function.
///
/// - Note: This is a best-effort operation.
/// According to the ECMAScript specification, calling
/// `FinalizationRegistry.prototype.unregister` does not guarantee that
/// a finalization callback will be suppressed if the target object has
/// already been garbage-collected and cleanup has been scheduled.
/// This means that the finalization callback should be tolerant of the
/// object being already collected.
/// See: https://tc39.es/ecma262/multipage/managing-memory.html#sec-finalization-registry.prototype.unregister
@inline(never) internal func _swift_js_closure_unregister(_ id: Int32) {
_swift_js_closure_unregister_extern(id)
}
// MARK: Type lowering/lifting
//
// The following part defines the parameter and return value lowering/lifting
// for a given type. They follow the following pattern:
//
// ```swift
// extension <#TargetType#> {
// // MARK: ImportTS
// @_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> <#WasmCoreType#> {
// }
// @_spi(BridgeJS) public static func bridgeJSLiftReturn(_ ...) -> <#Self#> {
// }
// // MARK: ExportSwift
// @_spi(BridgeJS) public static func bridgeJSLiftParameter(_ ...) -> <#Self#> {
// }
// @_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> <#WasmCoreType#> {
// }
// // MARK: Stack ABI
// @_spi(BridgeJS) public static func bridgeJSStackPop() -> <#Self#> {
// }
// @_spi(BridgeJS) public consuming func bridgeJSStackPush() {
// }
// }
// ```
//
// where:
// - <#TargetType#>: the higher-level type to be lowered/lifted
// - <#WasmCoreType#>: the corresponding WebAssembly core type or Void
// - `func bridgeJSLowerParameter()`: lower the given higher-level parameter to a WebAssembly core type
// - `func bridgeJSLiftReturn(_ ...) -> <#TargetType#>`: lift the given Wasm core type return value to a higher-level type
// - `func bridgeJSLiftParameter(_ ...) -> <#TargetType#>`: lift the given Wasm core type parameters to a higher-level type
// - `func bridgeJSLowerReturn() -> <#WasmCoreType#>`: lower the given higher-level return value to a Wasm core type
// - `func bridgeJSStackPop() -> <#TargetType#>`: no-arg overload that pops parameters from the param stack internally.
// Note: Pop order must match Swift's left-to-right argument evaluation order.
// - `func bridgeJSStackPush()`: push the value onto the return stack (used by _BridgedSwiftStackType for array elements)
//
// Optional types (ExportSwift only) additionally define:
// - `func bridgeJSLiftReturnFromSideChannel()`: lift optional from side-channel storage for protocol property getters
//
// See JSGlueGen.swift in BridgeJSLink for JS-side lowering/lifting implementation.
/// A protocol that Swift types that can appear as parameters or return values on
public protocol _BridgedSwiftTypeLoweredIntoSingleWasmCoreType {
associatedtype WasmCoreType
// MARK: ImportTS
consuming func bridgeJSLowerParameter() -> WasmCoreType
static func bridgeJSLiftReturn(_ value: WasmCoreType) -> Self
// MARK: ExportSwift
static func bridgeJSLiftParameter(_ value: WasmCoreType) -> Self
consuming func bridgeJSLowerReturn() -> WasmCoreType
}
public protocol _BridgedSwiftStackType {
associatedtype StackLiftResult = Self
static func bridgeJSStackPop() -> StackLiftResult
consuming func bridgeJSStackPush()
// MARK: Specialization points
/// Specialization point for popping an `Optional<Self>`
static func bridgeJSStackPopAsOptional() -> StackLiftResult?
/// Specialization point for pushing an `Optional<Self>`
static func bridgeJSStackPushAsOptional(_ value: consuming Self?)
}
extension _BridgedSwiftStackType {
/// Default implementation for popping an `Optional<Self>` using
/// a leading discriminator on the stack (0 for nil, 1 for some).
public static func bridgeJSStackPopAsOptional() -> StackLiftResult? {
let isSome = _swift_js_pop_i32()
if isSome == 0 {
return nil
}
return Self.bridgeJSStackPop()
}
/// Default implementation for pushing an `Optional<Self>` using
/// a leading discriminator on the stack (0 for nil, 1 for some).
public static func bridgeJSStackPushAsOptional(_ value: consuming Self?) {
switch consume value {
case .none:
_swift_js_push_i32(0)
case .some(let value):
value.bridgeJSStackPush()
_swift_js_push_i32(1)
}
}
}
/// Types that bridge with the same (isSome, value) ABI as Optional.
/// Used by JSUndefinedOr so all bridge methods delegate to Optional<Wrapped>.
@_spi(BridgeJS) public protocol _BridgedAsOptional {
associatedtype Wrapped
var asOptional: Wrapped? { get }
init(optional: Wrapped?)
}
@_spi(BridgeJS) extension Optional: _BridgedAsOptional {
public var asOptional: Wrapped? { self }
public init(optional: Wrapped?) { self = optional }
}
extension Bool: _BridgedSwiftTypeLoweredIntoSingleWasmCoreType, _BridgedSwiftStackType {
// MARK: ImportTS
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerParameter() -> Int32 {
self ? 1 : 0
}
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftReturn(_ value: Int32) -> Bool {
value == 1
}
// MARK: ExportSwift
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter(_ value: Int32) -> Bool {
value == 1
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Bool {
bridgeJSLiftParameter(_swift_js_pop_i32())
}
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerReturn() -> Int32 {
self ? 1 : 0
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(self ? 1 : 0)
}
}
extension Int: _BridgedSwiftTypeLoweredIntoSingleWasmCoreType, _BridgedSwiftStackType {
// MARK: ImportTS
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerParameter() -> Int32 {
Int32(self)
}
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftReturn(_ value: Int32) -> Int {
Int(value)
}
// MARK: ExportSwift
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter(_ value: Int32) -> Int {
Int(value)
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Int {
bridgeJSLiftParameter(_swift_js_pop_i32())
}
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerReturn() -> Int32 {
Int32(self)
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(Int32(self))
}
}
extension UInt: _BridgedSwiftTypeLoweredIntoSingleWasmCoreType, _BridgedSwiftStackType {
// MARK: ImportTS
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerParameter() -> Int32 {
Int32(bitPattern: UInt32(self))
}
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftReturn(_ value: Int32) -> UInt {
UInt(UInt32(bitPattern: value))
}
// MARK: ExportSwift
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter(_ value: Int32) -> UInt {
UInt(UInt32(bitPattern: value))
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> UInt {
bridgeJSLiftParameter(_swift_js_pop_i32())
}
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerReturn() -> Int32 {
Int32(bitPattern: UInt32(self))
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(Int32(bitPattern: UInt32(self)))
}
}
extension Int32: _BridgedSwiftStackType {
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Int32 {
_swift_js_pop_i32()
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(self)
}
}
extension Int64: _BridgedSwiftStackType {
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Int64 {
Int64(_swift_js_pop_i32())
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(Int32(self))
}
}
extension UInt32: _BridgedSwiftStackType {
@_spi(BridgeJS) public static func bridgeJSStackPop() -> UInt32 {
UInt32(bitPattern: _swift_js_pop_i32())
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(Int32(bitPattern: self))
}
}
extension UInt64: _BridgedSwiftStackType {
@_spi(BridgeJS) public static func bridgeJSStackPop() -> UInt64 {
UInt64(UInt32(bitPattern: _swift_js_pop_i32()))
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(Int32(bitPattern: UInt32(self)))
}
}
extension Float: _BridgedSwiftTypeLoweredIntoSingleWasmCoreType, _BridgedSwiftStackType {
// MARK: ImportTS
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerParameter() -> Float32 {
Float32(self)
}
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftReturn(_ value: Float32) -> Float {
Float(value)
}
// MARK: ExportSwift
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter(_ value: Float32) -> Float {
Float(value)
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Float {
bridgeJSLiftParameter(_swift_js_pop_f32())
}
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerReturn() -> Float32 {
Float32(self)
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_f32(Float32(self))
}
}
extension Double: _BridgedSwiftTypeLoweredIntoSingleWasmCoreType, _BridgedSwiftStackType {
// MARK: ImportTS
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerParameter() -> Float64 {
Float64(self)
}
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftReturn(_ value: Float64) -> Double {
Double(value)
}
// MARK: ExportSwift
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter(_ value: Float64) -> Double {
Double(value)
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Double {
bridgeJSLiftParameter(_swift_js_pop_f64())
}
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerReturn() -> Float64 {
Float64(self)
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_f64(Float64(self))
}
}
extension String: _BridgedSwiftStackType {
public typealias StackLiftResult = String
// MARK: ImportTS
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> Int32 {
return self.withUTF8 { b in
_swift_js_make_js_string(b.baseAddress.unsafelyUnwrapped, Int32(b.count))
}
}
@_spi(BridgeJS) public static func bridgeJSLiftReturn(_ bytesCount: Int32) -> String {
#if !arch(wasm32)
guard #available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *) else { _onlyAvailableOnWasm() }
#endif
return String(unsafeUninitializedCapacity: Int(bytesCount)) { b in
_swift_js_init_memory_with_result(b.baseAddress.unsafelyUnwrapped, Int32(bytesCount))
return Int(bytesCount)
}
}
// MARK: ExportSwift
@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ bytes: Int32, _ count: Int32) -> String {
#if !arch(wasm32)
guard #available(macOS 11.0, iOS 14.0, watchOS 7.0, tvOS 14.0, *) else { _onlyAvailableOnWasm() }
#endif
return String(unsafeUninitializedCapacity: Int(count)) { b in
_swift_js_init_memory(bytes, b.baseAddress.unsafelyUnwrapped)
return Int(count)
}
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> String {
let bytes = _swift_js_pop_i32()
let count = _swift_js_pop_i32()
return bridgeJSLiftParameter(bytes, count)
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
return self.withUTF8 { ptr in
_swift_js_return_string(ptr.baseAddress, Int32(ptr.count))
}
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
self.withUTF8 { ptr in
_swift_js_push_string(ptr.baseAddress, Int32(ptr.count))
}
}
}
extension JSObject: _BridgedSwiftStackType {
// JSObject is a non-final class, so we must explicitly specify the associated type
// rather than relying on the default `Self` (which Swift requires for covariant returns).
public typealias StackLiftResult = JSObject
// MARK: ImportTS
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerParameter() -> Int32 {
Int32(bitPattern: self.id)
}
@_spi(BridgeJS) public static func bridgeJSLiftReturn(_ id: Int32) -> JSObject {
JSObject(id: JavaScriptObjectRef(bitPattern: id))
}
// MARK: ExportSwift
@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ id: Int32) -> JSObject {
JSObject(id: JavaScriptObjectRef(bitPattern: id))
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> JSObject {
bridgeJSLiftParameter(_swift_js_pop_i32())
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Int32 {
return _swift_js_retain(Int32(bitPattern: self.id))
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(bridgeJSLowerReturn())
}
}
extension JSValue: _BridgedSwiftStackType {
public typealias StackLiftResult = JSValue
@_transparent
private static func bridgeJSRetainPayloadIfNeeded(kind: Int32, payload1: Int32) -> Int32 {
guard let kindEnum = JavaScriptValueKind(rawValue: UInt32(kind)) else {
return payload1
}
switch kindEnum {
case .string, .object, .symbol, .bigInt:
return _swift_js_retain(payload1)
default:
return payload1
}
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> JSValue {
let payload2 = _swift_js_pop_f64()
let payload1 = _swift_js_pop_i32()
let kind = _swift_js_pop_i32()
return bridgeJSLiftParameter(kind, payload1, payload2)
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() -> Void {
let lowered = bridgeJSLowerParameter()
let retainedPayload1 = Self.bridgeJSRetainPayloadIfNeeded(kind: lowered.kind, payload1: lowered.payload1)
_swift_js_push_i32(lowered.kind)
_swift_js_push_i32(retainedPayload1)
_swift_js_push_f64(lowered.payload2)
}
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (kind: Int32, payload1: Int32, payload2: Double) {
return withRawJSValue { raw in
(
kind: Int32(raw.kind.rawValue),
payload1: Int32(bitPattern: raw.payload1),
payload2: raw.payload2
)
}
}
@_spi(BridgeJS) public static func bridgeJSLiftParameter(
_ kind: Int32,
_ payload1: Int32,
_ payload2: Double
) -> JSValue {
let retainedPayload1 = bridgeJSRetainPayloadIfNeeded(kind: kind, payload1: payload1)
guard let kindEnum = JavaScriptValueKind(rawValue: UInt32(kind)) else {
fatalError("Invalid JSValue kind: \(kind)")
}
let rawValue = RawJSValue(
kind: kindEnum,
payload1: JavaScriptPayload1(UInt32(bitPattern: retainedPayload1)),
payload2: payload2
)
return rawValue.jsValue
}
@_spi(BridgeJS) public static func bridgeJSLiftReturn() -> JSValue {
bridgeJSStackPop()
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() {
bridgeJSStackPush()
}
}
/// A protocol that Swift heap objects exposed to JavaScript via `@JS class` must conform to.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
public protocol _BridgedSwiftHeapObject: AnyObject, _BridgedSwiftStackType {}
/// Define the lowering/lifting for `_BridgedSwiftHeapObject`
extension _BridgedSwiftHeapObject {
// MARK: ImportTS
@_spi(BridgeJS) @_transparent public func bridgeJSLowerParameter() -> UnsafeMutableRawPointer {
// Transfer ownership to JS for imported SwiftHeapObject parameters.
// JS side must eventually release (via release() or FinalizationRegistry).
return Unmanaged.passRetained(self).toOpaque()
}
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftReturn(_ pointer: UnsafeMutableRawPointer) -> Self {
// For protocol returns, take an unretained value since JS manages the lifetime
return Unmanaged<Self>.fromOpaque(pointer).takeUnretainedValue()
}
// MARK: ExportSwift
@_spi(BridgeJS) @_transparent public static func bridgeJSLiftParameter(_ pointer: UnsafeMutableRawPointer) -> Self {
Unmanaged<Self>.fromOpaque(pointer).takeUnretainedValue()
}
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerReturn() -> UnsafeMutableRawPointer {
// Perform a manual retain on the object, which will be balanced by a release called via FinalizationRegistry
return Unmanaged.passRetained(self).toOpaque()
}
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Self {
bridgeJSLiftParameter(_swift_js_pop_pointer())
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_pointer(Unmanaged.passRetained(self).toOpaque())
}
}
// MARK: Closure Box Protocol
/// A protocol that Swift closure box types must conform to.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
@_spi(BridgeJS) public protocol _BridgedSwiftClosureBox: AnyObject {}
extension _JSBridgedClass {
// MARK: ImportTS
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> Int32 { jsObject.bridgeJSLowerParameter() }
@_spi(BridgeJS) public static func bridgeJSLiftReturn(_ id: Int32) -> Self {
Self(unsafelyWrapping: JSObject.bridgeJSLiftReturn(id))
}
// MARK: ExportSwift
@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ id: Int32) -> Self {
Self(unsafelyWrapping: JSObject.bridgeJSLiftParameter(id))
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Int32 { jsObject.bridgeJSLowerReturn() }
public static func bridgeJSStackPop() -> Self {
Self(unsafelyWrapping: JSObject.bridgeJSStackPop())
}
public consuming func bridgeJSStackPush() {
jsObject.bridgeJSStackPush()
}
}
/// A protocol that Swift protocol wrappers exposed from JavaScript must conform to.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
public protocol _BridgedSwiftProtocolWrapper: _BridgedSwiftStackType {
var jsObject: JSObject { get }
static func bridgeJSLiftParameter(_ value: Int32) -> Self
}
extension _BridgedSwiftProtocolWrapper {
// MARK: ExportSwift
@_spi(BridgeJS) public static func bridgeJSLiftParameter() -> Self {
bridgeJSStackPop()
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Int32 {
jsObject.bridgeJSLowerReturn()
}
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> Int32 {
jsObject.bridgeJSLowerParameter()
}
// MARK: Stack ABI
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Self {
bridgeJSLiftParameter(_swift_js_pop_i32())
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(jsObject.bridgeJSLowerReturn())
}
}
/// A protocol that Swift enum types that do not have a payload can conform to.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
public protocol _BridgedSwiftEnumNoPayload {}
/// A protocol for raw value enums that enables automatic stack operations.
///
/// Conforming to this protocol provides default implementations of `_BridgedSwiftStackType`
/// methods by delegating to the raw value's stack operations. The raw value type must itself
/// conform to `_BridgedSwiftStackType`.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
public protocol _BridgedSwiftRawValueEnum: _BridgedSwiftStackType, RawRepresentable
where RawValue: _BridgedSwiftStackType, RawValue.StackLiftResult == RawValue {}
extension _BridgedSwiftRawValueEnum {
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Self {
Self(rawValue: RawValue.bridgeJSStackPop())!
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
rawValue.bridgeJSStackPush()
}
}
/// A protocol that Swift case enum types (enums without raw values or associated values) conform to.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
public protocol _BridgedSwiftCaseEnum: _BridgedSwiftStackType {
// MARK: ImportTS
@_spi(BridgeJS) consuming func bridgeJSLowerParameter() -> Int32
@_spi(BridgeJS) static func bridgeJSLiftReturn(_ value: Int32) -> Self
// MARK: ExportSwift
@_spi(BridgeJS) static func bridgeJSLiftParameter(_ value: Int32) -> Self
@_spi(BridgeJS) consuming func bridgeJSLowerReturn() -> Int32
}
extension _BridgedSwiftCaseEnum {
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Self {
bridgeJSLiftParameter(_swift_js_pop_i32())
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(bridgeJSLowerReturn())
}
}
/// A protocol that Swift associated value enum types conform to.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
public protocol _BridgedSwiftAssociatedValueEnum: _BridgedSwiftTypeLoweredIntoVoidType, _BridgedSwiftStackType
where StackLiftResult == Self {
/// Pops the payload of the associated value enum from the stack.
///
/// - Parameter caseId: The enum case ID.
/// - Returns: The associated value enum with its payload popped from the stack.
@_spi(BridgeJS) static func bridgeJSStackPopPayload(_ caseId: Int32) -> Self
/// Pushes the payload of the associated value enum onto the stack.
///
/// - Returns: The enum case ID.
@_spi(BridgeJS) consuming func bridgeJSStackPushPayload() -> Int32
}
extension _BridgedSwiftAssociatedValueEnum {
@_spi(BridgeJS) public static func bridgeJSStackPop() -> Self {
bridgeJSStackPopPayload(_swift_js_pop_i32())
}
@_spi(BridgeJS) public consuming func bridgeJSStackPush() {
_swift_js_push_i32(bridgeJSStackPushPayload())
}
public static func bridgeJSStackPopAsOptional() -> Self? {
let discriminator = _swift_js_pop_i32()
if discriminator == -1 {
return nil
}
return bridgeJSStackPopPayload(discriminator)
}
public static func bridgeJSStackPushAsOptional(_ value: consuming Self?) {
switch consume value {
case .none:
_swift_js_push_i32(-1)
case .some(let value):
_swift_js_push_i32(value.bridgeJSStackPushPayload())
}
}
@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ caseId: Int32) -> Self {
return bridgeJSStackPopPayload(caseId)
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() {
bridgeJSStackPush()
}
@_spi(BridgeJS) @_transparent public consuming func bridgeJSLowerParameter() -> Int32 {
return bridgeJSStackPushPayload()
}
@_spi(BridgeJS) public static func bridgeJSLiftReturn(_ caseId: Int32) -> Self {
return bridgeJSStackPopPayload(caseId)
}
}
/// A protocol that Swift struct types conform to.
///
/// The conformance is automatically synthesized by the BridgeJS code generator.
public protocol _BridgedSwiftStruct: _BridgedSwiftTypeLoweredIntoVoidType, _BridgedSwiftStackType
where StackLiftResult == Self {
// MARK: ExportSwift
@_spi(BridgeJS) static func bridgeJSStackPop() -> Self
@_spi(BridgeJS) consuming func bridgeJSStackPush() -> Void
/// Initializes a Swift struct by copying the fields from a bridged JS object.
init(unsafelyCopying jsObject: JSObject)
/// Converts the struct into a bridged JS object by copying its fields.
func toJSObject() -> JSObject
}
extension _BridgedSwiftStruct {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> Int32 {
return toJSObject().bridgeJSLowerReturn()
}
@_spi(BridgeJS) public static func bridgeJSLiftReturn(_ objectId: Int32) -> Self {
let jsObject = JSObject.bridgeJSLiftReturn(objectId)
return Self(unsafelyCopying: jsObject)
}
@_spi(BridgeJS) public static func bridgeJSLiftParameter() -> Self {
bridgeJSStackPop()
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() {
bridgeJSStackPush()
}
}
extension _BridgedSwiftEnumNoPayload where Self: RawRepresentable, RawValue == String {
// MARK: ImportTS
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> Int32 { rawValue.bridgeJSLowerParameter() }
@_spi(BridgeJS) public static func bridgeJSLiftReturn(_ id: Int32) -> Self {
Self(rawValue: .bridgeJSLiftReturn(id))!
}
// MARK: ExportSwift
@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ bytes: Int32, _ count: Int32) -> Self {
Self(rawValue: .bridgeJSLiftParameter(bytes, count))!
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void { rawValue.bridgeJSLowerReturn() }
}
extension _BridgedSwiftEnumNoPayload
where Self: RawRepresentable, RawValue: _BridgedSwiftTypeLoweredIntoSingleWasmCoreType {
// MARK: ImportTS
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> RawValue.WasmCoreType {
rawValue.bridgeJSLowerParameter()
}
@_spi(BridgeJS) public static func bridgeJSLiftReturn(_ value: RawValue.WasmCoreType) -> Self {
Self(rawValue: .bridgeJSLiftReturn(value))!
}
// MARK: ExportSwift
@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ value: RawValue.WasmCoreType) -> Self {
Self(rawValue: .bridgeJSLiftParameter(value))!
}
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> RawValue.WasmCoreType {
rawValue.bridgeJSLowerReturn()
}
}
// MARK: Wasm externs used by generated enum glue
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_init_memory")
private func _swift_js_init_memory_extern(_ sourceId: Int32, _ ptr: UnsafeMutablePointer<UInt8>)
#else
private func _swift_js_init_memory_extern(_ sourceId: Int32, _ ptr: UnsafeMutablePointer<UInt8>) {
_onlyAvailableOnWasm()
}
#endif
/// Initializes WebAssembly memory with a Uint8Array referenced by `sourceId` at `ptr`.
/// Note that the ownership of the source Uint8Array id is taken by the callee, so callers
/// must not release the source Uint8Array id by themselves.
///
/// - Parameter sourceId: The object ID of the source Uint8Array.
/// - Parameter ptr: The pointer to the WebAssembly memory to initialize.
@_spi(BridgeJS) @inline(never) public func _swift_js_init_memory(_ sourceId: Int32, _ ptr: UnsafeMutablePointer<UInt8>)
{
_swift_js_init_memory_extern(sourceId, ptr)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_push_string")
private func _swift_js_push_string_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32)
#else
private func _swift_js_push_string_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) {
_onlyAvailableOnWasm()
}
#endif
@_spi(BridgeJS) @inline(never) public func _swift_js_push_string(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) {
_swift_js_push_string_extern(ptr, len)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_push_i32")
private func _swift_js_push_i32_extern(_ value: Int32)
#else
private func _swift_js_push_i32_extern(_ value: Int32) {
_onlyAvailableOnWasm()
}
#endif
@_spi(BridgeJS) @inline(never) public func _swift_js_push_i32(_ value: Int32) {
_swift_js_push_i32_extern(value)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_push_f32")
private func _swift_js_push_f32_extern(_ value: Float32)
#else
private func _swift_js_push_f32_extern(_ value: Float32) {
_onlyAvailableOnWasm()
}
#endif
@_spi(BridgeJS) @inline(never) public func _swift_js_push_f32(_ value: Float32) {
_swift_js_push_f32_extern(value)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_push_f64")
private func _swift_js_push_f64_extern(_ value: Float64)
#else
private func _swift_js_push_f64_extern(_ value: Float64) {
_onlyAvailableOnWasm()
}
#endif
@_spi(BridgeJS) @inline(never) public func _swift_js_push_f64(_ value: Float64) {
_swift_js_push_f64_extern(value)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_pop_i32")
private func _swift_js_pop_i32_extern() -> Int32
#else
private func _swift_js_pop_i32_extern() -> Int32 {
_onlyAvailableOnWasm()
}
#endif
@_spi(BridgeJS) @inline(never) public func _swift_js_pop_i32() -> Int32 {
_swift_js_pop_i32_extern()
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_pop_f32")
private func _swift_js_pop_f32_extern() -> Float32
#else
private func _swift_js_pop_f32_extern() -> Float32 {
_onlyAvailableOnWasm()
}
#endif
@_spi(BridgeJS) @inline(never) public func _swift_js_pop_f32() -> Float32 {
_swift_js_pop_f32_extern()
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_pop_f64")
private func _swift_js_pop_f64_extern() -> Float64
#else
private func _swift_js_pop_f64_extern() -> Float64 {
_onlyAvailableOnWasm()
}
#endif
@_spi(BridgeJS) @inline(never) public func _swift_js_pop_f64() -> Float64 {
_swift_js_pop_f64_extern()
}
// MARK: Wasm externs used by type lowering/lifting
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_make_js_string")
private func _swift_js_make_js_string_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) -> Int32
#else
/// Creates a JavaScript string from UTF-8 data in WebAssembly memory
private func _swift_js_make_js_string_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) -> Int32 {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_make_js_string(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) -> Int32 {
_swift_js_make_js_string_extern(ptr, len)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_init_memory_with_result")
private func _swift_js_init_memory_with_result_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32)
#else
/// Initializes WebAssembly memory with result data of JavaScript function call
private func _swift_js_init_memory_with_result_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_init_memory_with_result(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) {
_swift_js_init_memory_with_result_extern(ptr, len)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_return_string")
private func _swift_js_return_string_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32)
#else
/// Write a string to reserved string storage to be returned to JavaScript
private func _swift_js_return_string_extern(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_return_string(_ ptr: UnsafePointer<UInt8>?, _ len: Int32) {
_swift_js_return_string_extern(ptr, len)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_retain")
private func _swift_js_retain_extern(_ id: Int32) -> Int32
#else
/// Retains a JavaScript object reference to ensure the object id
/// remains valid after the function returns
private func _swift_js_retain_extern(_ id: Int32) -> Int32 {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_retain(_ id: Int32) -> Int32 {
_swift_js_retain_extern(id)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_return_optional_bool")
private func _swift_js_return_optional_bool_extern(_ isSome: Int32, _ value: Int32)
#else
/// Sets the optional bool for return value storage
private func _swift_js_return_optional_bool_extern(_ isSome: Int32, _ value: Int32) {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_return_optional_bool(_ isSome: Int32, _ value: Int32) {
_swift_js_return_optional_bool_extern(isSome, value)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_get_optional_int_presence")
private func _swift_js_get_optional_int_presence_extern() -> Int32
#else
private func _swift_js_get_optional_int_presence_extern() -> Int32 {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_get_optional_int_presence() -> Int32 {
_swift_js_get_optional_int_presence_extern()
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_get_optional_int_value")
private func _swift_js_get_optional_int_value_extern() -> Int32
#else
private func _swift_js_get_optional_int_value_extern() -> Int32 {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_get_optional_int_value() -> Int32 {
_swift_js_get_optional_int_value_extern()
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_return_optional_int")
private func _swift_js_return_optional_int_extern(_ isSome: Int32, _ value: Int32)
#else
/// Sets the optional int for return value storage
private func _swift_js_return_optional_int_extern(_ isSome: Int32, _ value: Int32) {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_return_optional_int(_ isSome: Int32, _ value: Int32) {
_swift_js_return_optional_int_extern(isSome, value)
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_get_optional_string")
private func _swift_js_get_optional_string_extern() -> Int32
#else
private func _swift_js_get_optional_string_extern() -> Int32 {
_onlyAvailableOnWasm()
}
#endif
@inline(never) func _swift_js_get_optional_string() -> Int32 {
_swift_js_get_optional_string_extern()
}
#if arch(wasm32)
@_extern(wasm, module: "bjs", name: "swift_js_return_optional_string")
private func _swift_js_return_optional_string_extern(_ isSome: Int32, _ ptr: UnsafePointer<UInt8>?, _ len: Int32)
#else