Start migrating imported functions to the new definition style (#252)

kateinoigakukun · web-flow · commit 2bb06942d9e5 · 2024-06-11T20:14:01.000+09:00
* Start migrating imported functions to the new definition style

Use of different function names for C-name and Wasm's import name is a
bit confusing. Also use of unprefixed function names in the C code is
not a good practice. This commit starts migrating imported functions to
the new naming convention and removes duplicated function definitions
just for IDE support by using macro.

* Migrate rest of imported functions

* Migrate JavaScriptBigIntSupport module
diff --git a/Sources/JavaScriptBigIntSupport/JSBigInt+I64.swift b/Sources/JavaScriptBigIntSupport/JSBigInt+I64.swift
@@ -3,18 +3,18 @@ import _CJavaScriptBigIntSupport
 
 extension JSBigInt: JSBigIntExtended {
     public var int64Value: Int64 {
-        _bigint_to_i64(id, true)
+        swjs_bigint_to_i64(id, true)
     }
 
     public var uInt64Value: UInt64 {
-        UInt64(bitPattern: _bigint_to_i64(id, false))
+        UInt64(bitPattern: swjs_bigint_to_i64(id, false))
     }
 
     public convenience init(_ value: Int64) {
-        self.init(id: _i64_to_bigint(value, true))
+        self.init(id: swjs_i64_to_bigint(value, true))
     }
 
     public convenience init(unsigned value: UInt64) {
-        self.init(id: _i64_to_bigint(Int64(bitPattern: value), false))
+        self.init(id: swjs_i64_to_bigint(Int64(bitPattern: value), false))
     }
 }
diff --git a/Sources/JavaScriptBigIntSupport/XcodeSupport.swift b/Sources/JavaScriptBigIntSupport/XcodeSupport.swift
diff --git a/Sources/JavaScriptEventLoop/JavaScriptEventLoop.swift b/Sources/JavaScriptEventLoop/JavaScriptEventLoop.swift
@@ -94,7 +94,7 @@ public final class JavaScriptEventLoop: SerialExecutor, @unchecked Sendable {
         #if compiler(>=5.9)
         typealias swift_task_asyncMainDrainQueue_hook_Fn = @convention(thin) (swift_task_asyncMainDrainQueue_original, swift_task_asyncMainDrainQueue_override) -> Void
         let swift_task_asyncMainDrainQueue_hook_impl: swift_task_asyncMainDrainQueue_hook_Fn = { _, _ in
-            _unsafe_event_loop_yield()
+            swjs_unsafe_event_loop_yield()
         }
         swift_task_asyncMainDrainQueue_hook = unsafeBitCast(swift_task_asyncMainDrainQueue_hook_impl, to: UnsafeMutableRawPointer?.self)
         #endif
@@ -225,8 +225,3 @@ public extension JSPromise {
 }
 
 #endif
-
-// See `Sources/JavaScriptKit/XcodeSupport.swift` for rationale of the stub functions.
-#if !arch(wasm32)
-    func _unsafe_event_loop_yield() { fatalError() }
-#endif
diff --git a/Sources/JavaScriptKit/BasicObjects/JSTypedArray.swift b/Sources/JavaScriptKit/BasicObjects/JSTypedArray.swift
@@ -47,7 +47,7 @@ public class JSTypedArray<Element>: JSBridgedClass, ExpressibleByArrayLiteral wh
     /// - Parameter array: The array that will be copied to create a new instance of TypedArray
     public convenience init(_ array: [Element]) {
         let jsArrayRef = array.withUnsafeBufferPointer { ptr in
-            _create_typed_array(Self.constructor!.id, ptr.baseAddress!, Int32(array.count))
+            swjs_create_typed_array(Self.constructor!.id, ptr.baseAddress!, Int32(array.count))
         }
         self.init(unsafelyWrapping: JSObject(id: jsArrayRef))
     }
@@ -82,7 +82,7 @@ public class JSTypedArray<Element>: JSBridgedClass, ExpressibleByArrayLiteral wh
         let rawBuffer = UnsafeMutableBufferPointer<UInt8>.allocate(capacity: bytesLength)
         defer { rawBuffer.deallocate() }
         let baseAddress = rawBuffer.baseAddress!
-        _load_typed_array(jsObject.id, baseAddress)
+        swjs_load_typed_array(jsObject.id, baseAddress)
         let length = bytesLength / MemoryLayout<Element>.size
         let rawBaseAddress = UnsafeRawPointer(baseAddress)
         let bufferPtr = UnsafeBufferPointer<Element>(
@@ -113,7 +113,7 @@ public class JSTypedArray<Element>: JSBridgedClass, ExpressibleByArrayLiteral wh
             let rawBuffer = UnsafeMutableBufferPointer<UInt8>.allocate(capacity: bytesLength)
             defer { rawBuffer.deallocate() }
             let baseAddress = rawBuffer.baseAddress!
-            _load_typed_array(jsObject.id, baseAddress)
+            swjs_load_typed_array(jsObject.id, baseAddress)
             let length = bytesLength / MemoryLayout<Element>.size
             let rawBaseAddress = UnsafeRawPointer(baseAddress)
             let bufferPtr = UnsafeBufferPointer<Element>(
diff --git a/Sources/JavaScriptKit/FundamentalObjects/JSBigInt.swift b/Sources/JavaScriptKit/FundamentalObjects/JSBigInt.swift
@@ -15,13 +15,13 @@ public final class JSBigInt: JSObject {
     /// This doesn't require [JS-BigInt-integration](https://github.com/WebAssembly/JS-BigInt-integration) feature.
     public init(_slowBridge value: Int64) {
         let value = UInt64(bitPattern: value)
-        super.init(id: _i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), true))
+        super.init(id: swjs_i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), true))
     }
 
     /// Instantiate a new `JSBigInt` with given UInt64 value in a slow path
     /// This doesn't require [JS-BigInt-integration](https://github.com/WebAssembly/JS-BigInt-integration) feature.
     public init(_slowBridge value: UInt64) {
-        super.init(id: _i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), false))
+        super.init(id: swjs_i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), false))
     }
 
     override public var jsValue: JSValue {
diff --git a/Sources/JavaScriptKit/FundamentalObjects/JSClosure.swift b/Sources/JavaScriptKit/FundamentalObjects/JSClosure.swift
@@ -22,7 +22,7 @@ public class JSOneshotClosure: JSObject, JSClosureProtocol {
         // 2. Create a new JavaScript function which calls the given Swift function.
         hostFuncRef = JavaScriptHostFuncRef(bitPattern: ObjectIdentifier(self))
         id = withExtendedLifetime(JSString(file)) { file in
-          _create_function(hostFuncRef, line, file.asInternalJSRef())
+            swjs_create_function(hostFuncRef, line, file.asInternalJSRef())
         }
 
         // 3. Retain the given body in static storage by `funcRef`.
@@ -88,7 +88,7 @@ public class JSClosure: JSFunction, JSClosureProtocol {
         // 2. Create a new JavaScript function which calls the given Swift function.
         hostFuncRef = JavaScriptHostFuncRef(bitPattern: ObjectIdentifier(self))
         id = withExtendedLifetime(JSString(file)) { file in
-          _create_function(hostFuncRef, line, file.asInternalJSRef())
+            swjs_create_function(hostFuncRef, line, file.asInternalJSRef())
         }
 
         // 3. Retain the given body in static storage by `funcRef`.
diff --git a/Sources/JavaScriptKit/FundamentalObjects/JSFunction.swift b/Sources/JavaScriptKit/FundamentalObjects/JSFunction.swift
@@ -55,7 +55,7 @@ public class JSFunction: JSObject {
     public func new(arguments: [ConvertibleToJSValue]) -> JSObject {
         arguments.withRawJSValues { rawValues in
             rawValues.withUnsafeBufferPointer { bufferPointer in
-                JSObject(id: _call_new(self.id, bufferPointer.baseAddress!, Int32(bufferPointer.count)))
+                JSObject(id: swjs_call_new(self.id, bufferPointer.baseAddress!, Int32(bufferPointer.count)))
             }
         }
     }
@@ -101,7 +101,7 @@ public class JSFunction: JSObject {
                 let argc = bufferPointer.count
                 var payload1 = JavaScriptPayload1()
                 var payload2 = JavaScriptPayload2()
-                let resultBitPattern = _call_function_no_catch(
+                let resultBitPattern = swjs_call_function_no_catch(
                     id, argv, Int32(argc),
                     &payload1, &payload2
                 )
@@ -121,7 +121,7 @@ public class JSFunction: JSObject {
                 let argc = bufferPointer.count
                 var payload1 = JavaScriptPayload1()
                 var payload2 = JavaScriptPayload2()
-                let resultBitPattern = _call_function_with_this_no_catch(this.id,
+                let resultBitPattern = swjs_call_function_with_this_no_catch(this.id,
                     id, argv, Int32(argc),
                     &payload1, &payload2
                 )
diff --git a/Sources/JavaScriptKit/FundamentalObjects/JSObject.swift b/Sources/JavaScriptKit/FundamentalObjects/JSObject.swift
@@ -130,7 +130,7 @@ public class JSObject: Equatable {
     /// - Parameter constructor: The constructor function to check.
     /// - Returns: The result of `instanceof` in the JavaScript environment.
     public func isInstanceOf(_ constructor: JSFunction) -> Bool {
-        _instanceof(id, constructor.id)
+        swjs_instanceof(id, constructor.id)
     }
 
     static let _JS_Predef_Value_Global: JavaScriptObjectRef = 0
@@ -139,7 +139,7 @@ public class JSObject: Equatable {
     /// This allows access to the global properties and global names by accessing the `JSObject` returned.
     public static let global = JSObject(id: _JS_Predef_Value_Global)
 
-    deinit { _release(id) }
+    deinit { swjs_release(id) }
 
     /// Returns a Boolean value indicating whether two values point to same objects.
     ///
diff --git a/Sources/JavaScriptKit/FundamentalObjects/JSString.swift b/Sources/JavaScriptKit/FundamentalObjects/JSString.swift
@@ -23,20 +23,20 @@ public struct JSString: LosslessStringConvertible, Equatable {
         lazy var jsRef: JavaScriptObjectRef = {
             self.shouldDealocateRef = true
             return buffer.withUTF8 { bufferPtr in
-                return _decode_string(bufferPtr.baseAddress!, Int32(bufferPtr.count))
+                return swjs_decode_string(bufferPtr.baseAddress!, Int32(bufferPtr.count))
             }
         }()
 
         lazy var buffer: String = {
             var bytesRef: JavaScriptObjectRef = 0
-            let bytesLength = Int(_encode_string(jsRef, &bytesRef))
+            let bytesLength = Int(swjs_encode_string(jsRef, &bytesRef))
             // +1 for null terminator
             let buffer = malloc(Int(bytesLength + 1))!.assumingMemoryBound(to: UInt8.self)
             defer {
                 free(buffer)
-                _release(bytesRef)
+                swjs_release(bytesRef)
             }
-            _load_string(bytesRef, buffer)
+            swjs_load_string(bytesRef, buffer)
             buffer[bytesLength] = 0
             return String(decodingCString: UnsafePointer(buffer), as: UTF8.self)
         }()
@@ -52,7 +52,7 @@ public struct JSString: LosslessStringConvertible, Equatable {
 
         deinit {
             guard shouldDealocateRef else { return }
-            _release(jsRef)
+            swjs_release(jsRef)
         }
     }
 
diff --git a/Sources/JavaScriptKit/FundamentalObjects/JSThrowingFunction.swift b/Sources/JavaScriptKit/FundamentalObjects/JSThrowingFunction.swift
@@ -44,7 +44,7 @@ public class JSThrowingFunction {
                 var exceptionKind = JavaScriptValueKindAndFlags()
                 var exceptionPayload1 = JavaScriptPayload1()
                 var exceptionPayload2 = JavaScriptPayload2()
-                let resultObj = _call_throwing_new(
+                let resultObj = swjs_call_throwing_new(
                     self.base.id, argv, Int32(argc),
                     &exceptionKind, &exceptionPayload1, &exceptionPayload2
                 )
@@ -73,13 +73,13 @@ private func invokeJSFunction(_ jsFunc: JSFunction, arguments: [ConvertibleToJSV
             var payload1 = JavaScriptPayload1()
             var payload2 = JavaScriptPayload2()
             if let thisId = this?.id {
-                let resultBitPattern = _call_function_with_this(
+                let resultBitPattern = swjs_call_function_with_this(
                     thisId, id, argv, Int32(argc),
                     &payload1, &payload2
                 )
                 kindAndFlags = unsafeBitCast(resultBitPattern, to: JavaScriptValueKindAndFlags.self)
             } else {
-                let resultBitPattern = _call_function(
+                let resultBitPattern = swjs_call_function(
                     id, argv, Int32(argc),
                     &payload1, &payload2
                 )
diff --git a/Sources/JavaScriptKit/JSValue.swift b/Sources/JavaScriptKit/JSValue.swift
@@ -196,7 +196,7 @@ extension JSValue: ExpressibleByNilLiteral {
 
 public func getJSValue(this: JSObject, name: JSString) -> JSValue {
     var rawValue = RawJSValue()
-    let rawBitPattern = _get_prop(
+    let rawBitPattern = swjs_get_prop(
         this.id, name.asInternalJSRef(),
         &rawValue.payload1, &rawValue.payload2
     )
@@ -206,13 +206,13 @@ public func getJSValue(this: JSObject, name: JSString) -> JSValue {
 
 public func setJSValue(this: JSObject, name: JSString, value: JSValue) {
     value.withRawJSValue { rawValue in
-        _set_prop(this.id, name.asInternalJSRef(), rawValue.kind, rawValue.payload1, rawValue.payload2)
+        swjs_set_prop(this.id, name.asInternalJSRef(), rawValue.kind, rawValue.payload1, rawValue.payload2)
     }
 }
 
 public func getJSValue(this: JSObject, index: Int32) -> JSValue {
     var rawValue = RawJSValue()
-    let rawBitPattern = _get_subscript(
+    let rawBitPattern = swjs_get_subscript(
         this.id, index,
         &rawValue.payload1, &rawValue.payload2
     )
@@ -222,15 +222,15 @@ public func getJSValue(this: JSObject, index: Int32) -> JSValue {
 
 public func setJSValue(this: JSObject, index: Int32, value: JSValue) {
     value.withRawJSValue { rawValue in
-        _set_subscript(this.id, index,
+        swjs_set_subscript(this.id, index,
                        rawValue.kind,
                        rawValue.payload1, rawValue.payload2)
     }
 }
 
 public func getJSValue(this: JSObject, symbol: JSSymbol) -> JSValue {
     var rawValue = RawJSValue()
-    let rawBitPattern = _get_prop(
+    let rawBitPattern = swjs_get_prop(
         this.id, symbol.id,
         &rawValue.payload1, &rawValue.payload2
     )
@@ -240,7 +240,7 @@ public func getJSValue(this: JSObject, symbol: JSSymbol) -> JSValue {
 
 public func setJSValue(this: JSObject, symbol: JSSymbol, value: JSValue) {
     value.withRawJSValue { rawValue in
-        _set_prop(this.id, symbol.id, rawValue.kind, rawValue.payload1, rawValue.payload2)
+        swjs_set_prop(this.id, symbol.id, rawValue.kind, rawValue.payload1, rawValue.payload2)
     }
 }
 
diff --git a/Sources/JavaScriptKit/XcodeSupport.swift b/Sources/JavaScriptKit/XcodeSupport.swift
diff --git a/Sources/_CJavaScriptBigIntSupport/include/_CJavaScriptKit+I64.h b/Sources/_CJavaScriptBigIntSupport/include/_CJavaScriptKit+I64.h
diff --git a/Sources/_CJavaScriptKit/include/_CJavaScriptKit.h b/Sources/_CJavaScriptKit/include/_CJavaScriptKit.h

Original file line number	Diff line number	Diff line change
`@@ -3,18 +3,18 @@ import _CJavaScriptBigIntSupport`
`3`	`3`
`4`	`4`	`extension JSBigInt: JSBigIntExtended {`
`5`	`5`	`public var int64Value: Int64 {`
`6`		`- _bigint_to_i64(id, true)`
	`6`	`+ swjs_bigint_to_i64(id, true)`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`public var uInt64Value: UInt64 {`
`10`		`- UInt64(bitPattern: _bigint_to_i64(id, false))`
	`10`	`+ UInt64(bitPattern: swjs_bigint_to_i64(id, false))`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`public convenience init(_ value: Int64) {`
`14`		`- self.init(id: _i64_to_bigint(value, true))`
	`14`	`+ self.init(id: swjs_i64_to_bigint(value, true))`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`public convenience init(unsigned value: UInt64) {`
`18`		`- self.init(id: _i64_to_bigint(Int64(bitPattern: value), false))`
	`18`	`+ self.init(id: swjs_i64_to_bigint(Int64(bitPattern: value), false))`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,13 +15,13 @@ public final class JSBigInt: JSObject {`
`15`	`15`	`/// This doesn't require [JS-BigInt-integration](https://github.com/WebAssembly/JS-BigInt-integration) feature.`
`16`	`16`	`public init(_slowBridge value: Int64) {`
`17`	`17`	`let value = UInt64(bitPattern: value)`
`18`		`- super.init(id: _i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), true))`
	`18`	`+ super.init(id: swjs_i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), true))`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	/// Instantiate a new `JSBigInt` with given UInt64 value in a slow path
`22`	`22`	`/// This doesn't require [JS-BigInt-integration](https://github.com/WebAssembly/JS-BigInt-integration) feature.`
`23`	`23`	`public init(_slowBridge value: UInt64) {`
`24`		`- super.init(id: _i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), false))`
	`24`	`+ super.init(id: swjs_i64_to_bigint_slow(UInt32(value & 0xffffffff), UInt32(value >> 32), false))`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`override public var jsValue: JSValue {`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public class JSFunction: JSObject {`
`55`	`55`	`public func new(arguments: [ConvertibleToJSValue]) -> JSObject {`
`56`	`56`	`arguments.withRawJSValues { rawValues in`
`57`	`57`	`rawValues.withUnsafeBufferPointer { bufferPointer in`
`58`		`- JSObject(id: _call_new(self.id, bufferPointer.baseAddress!, Int32(bufferPointer.count)))`
	`58`	`+ JSObject(id: swjs_call_new(self.id, bufferPointer.baseAddress!, Int32(bufferPointer.count)))`
`59`	`59`	`}`
`60`	`60`	`}`
`61`	`61`	`}`
`@@ -101,7 +101,7 @@ public class JSFunction: JSObject {`
`101`	`101`	`let argc = bufferPointer.count`
`102`	`102`	`var payload1 = JavaScriptPayload1()`
`103`	`103`	`var payload2 = JavaScriptPayload2()`
`104`		`- let resultBitPattern = _call_function_no_catch(`
	`104`	`+ let resultBitPattern = swjs_call_function_no_catch(`
`105`	`105`	`id, argv, Int32(argc),`
`106`	`106`	`&payload1, &payload2`
`107`	`107`	`)`
`@@ -121,7 +121,7 @@ public class JSFunction: JSObject {`
`121`	`121`	`let argc = bufferPointer.count`
`122`	`122`	`var payload1 = JavaScriptPayload1()`
`123`	`123`	`var payload2 = JavaScriptPayload2()`
`124`		`- let resultBitPattern = _call_function_with_this_no_catch(this.id,`
	`124`	`+ let resultBitPattern = swjs_call_function_with_this_no_catch(this.id,`
`125`	`125`	`id, argv, Int32(argc),`
`126`	`126`	`&payload1, &payload2`
`127`	`127`	`)`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ extension JSValue: ExpressibleByNilLiteral {`
`196`	`196`
`197`	`197`	`public func getJSValue(this: JSObject, name: JSString) -> JSValue {`
`198`	`198`	`var rawValue = RawJSValue()`
`199`		`- let rawBitPattern = _get_prop(`
	`199`	`+ let rawBitPattern = swjs_get_prop(`
`200`	`200`	`this.id, name.asInternalJSRef(),`
`201`	`201`	`&rawValue.payload1, &rawValue.payload2`
`202`	`202`	`)`
`@@ -206,13 +206,13 @@ public func getJSValue(this: JSObject, name: JSString) -> JSValue {`
`206`	`206`
`207`	`207`	`public func setJSValue(this: JSObject, name: JSString, value: JSValue) {`
`208`	`208`	`value.withRawJSValue { rawValue in`
`209`		`- _set_prop(this.id, name.asInternalJSRef(), rawValue.kind, rawValue.payload1, rawValue.payload2)`
	`209`	`+ swjs_set_prop(this.id, name.asInternalJSRef(), rawValue.kind, rawValue.payload1, rawValue.payload2)`
`210`	`210`	`}`
`211`	`211`	`}`
`212`	`212`
`213`	`213`	`public func getJSValue(this: JSObject, index: Int32) -> JSValue {`
`214`	`214`	`var rawValue = RawJSValue()`
`215`		`- let rawBitPattern = _get_subscript(`
	`215`	`+ let rawBitPattern = swjs_get_subscript(`
`216`	`216`	`this.id, index,`
`217`	`217`	`&rawValue.payload1, &rawValue.payload2`
`218`	`218`	`)`
`@@ -222,15 +222,15 @@ public func getJSValue(this: JSObject, index: Int32) -> JSValue {`
`222`	`222`
`223`	`223`	`public func setJSValue(this: JSObject, index: Int32, value: JSValue) {`
`224`	`224`	`value.withRawJSValue { rawValue in`
`225`		`- _set_subscript(this.id, index,`
	`225`	`+ swjs_set_subscript(this.id, index,`
`226`	`226`	`rawValue.kind,`
`227`	`227`	`rawValue.payload1, rawValue.payload2)`
`228`	`228`	`}`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`public func getJSValue(this: JSObject, symbol: JSSymbol) -> JSValue {`
`232`	`232`	`var rawValue = RawJSValue()`
`233`		`- let rawBitPattern = _get_prop(`
	`233`	`+ let rawBitPattern = swjs_get_prop(`
`234`	`234`	`this.id, symbol.id,`
`235`	`235`	`&rawValue.payload1, &rawValue.payload2`
`236`	`236`	`)`
`@@ -240,7 +240,7 @@ public func getJSValue(this: JSObject, symbol: JSSymbol) -> JSValue {`
`240`	`240`
`241`	`241`	`public func setJSValue(this: JSObject, symbol: JSSymbol, value: JSValue) {`
`242`	`242`	`value.withRawJSValue { rawValue in`
`243`		`- _set_prop(this.id, symbol.id, rawValue.kind, rawValue.payload1, rawValue.payload2)`
	`243`	`+ swjs_set_prop(this.id, symbol.id, rawValue.kind, rawValue.payload1, rawValue.payload2)`
`244`	`244`	`}`
`245`	`245`	`}`
`246`	`246`