Add bindings to updated ArrayBuffer, SharedArrayBuffer, and Atomics

Author: cometkim

jscomp/others/js.ml

@@ -244,12 +244,21 @@ module Math = Js_math
 module Obj = Js_obj
 (** Provide utilities for `Js.t` *)
 
+module ArrayBuffer = Js_array_buffer
+(** Provide utilities for `ArrayBuffer` object *)
+
+module SharedArrayBuffer = Js_shared_array_buffer
+(** Provide utilities for `SharedArrayBuffer` object *)
+
 module Typed_array = Js_typed_array
 (** Provide bindings for JS typed array *)
 
 module TypedArray2 = Js_typed_array2
 (** Provide bindings for JS typed array *)
 
+module Atomics = Js_atomics
+(** Provide bindings for JS `Atomics` utilities *)
+
 module Types = Js_types
 (** Provide utilities for manipulating JS types  *)
 

jscomp/others/js_array_buffer.res

@@ -0,0 +1,34 @@
+@@uncurried
+
+/***
+The underlying buffer that the typed arrays provide views of
+
+**see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)
+*/
+type t = {
+  byteLength: int,
+  maxByteLength: int,
+  detached: bool,
+  resizable: bool,
+}
+
+type makeOptions = {
+  maxByteLength?: int
+}
+
+@new /** takes length. initializes elements to 0 */
+external make: (int, makeOptions) => t = "ArrayBuffer"
+let make = (length, ~maxByteLength=?) => make(length, { maxByteLength: ?maxByteLength })
+
+/* ArrayBuffer.isView: seems pointless with a type system */
+
+@get external byteLength: t => int = "byteLength"
+@get external maxByteLength: t => int = "maxByteLength"
+@get external detached: t => bool = "detached"
+@get external resizable: t => bool = "resizable"
+
+@send external slice: (t, ~start: int, ~end_: int) => t = "slice"
+@send external sliceFrom: (t, int) => t = "slice"
+
+@send external transfer: (t, ~newByteLength: int=?) => t = "transfer"
+@send external transferToFixedLength: (t, ~newByteLength: int=?) => t = "transferToFixedLength"

jscomp/others/js_atomics.res

@@ -0,0 +1,56 @@
+@@uncurried
+
+@scope("Atomics") external isLockFree: int => bool = "isLockFree"
+
+module MakeOps = (TA: Js_typed_array2.S) => {
+  @scope("Atomics") external add: (TA.t, int, int) => TA.elt = "add"
+  @scope("Atomics") external sub: (TA.t, int, int) => TA.elt = "sub"
+  @scope("Atomics") external and_: (TA.t, int, int) => TA.elt = "and"
+  @scope("Atomics") external or_: (TA.t, int, int) => TA.elt = "or"
+  @scope("Atomics") external xor: (TA.t, int, int) => TA.elt = "xor"
+  @scope("Atomics") external load: (TA.t, ~index: int) => TA.elt = "load"
+  @scope("Atomics") external store: (TA.t, ~index: int, ~value: TA.elt) => TA.elt = "store"
+  @scope("Atomics") external exchange: (TA.t, ~index: int, ~value: TA.elt) => TA.elt = "exchange"
+  @scope("Atomics") external compareExchange: (TA.t, ~index: int, ~expectedValue: TA.elt, ~replacementValue: TA.elt) => TA.elt = "compareExchange"
+}
+
+module MakeFutex = (TA: Js_typed_array2.S) => {
+  // These operations are supported only when TA is Int32Array or BigInt64Array, and also underlying buffer is SharedArrayBuffer
+
+  @scope("Atomics") external wait: (TA.t, ~index: int, ~value: TA.elt) => [#ok | #"not-equal"] = "wait"
+  @scope("Atomics") external waitWithTimeout: (TA.t, ~index: int, ~value: TA.elt, ~timeout: int) => [#ok | #"not-equal" | #"timed-out"] = "wait"
+
+  @scope("Atomics") external waitAsync: (TA.t, ~index: int, ~value: TA.elt) => promise<[#ok | #"not-equal"]> = "waitAsync"
+  @scope("Atomics") external waitAsyncWithTimeout: (TA.t, ~index: int, ~value: TA.elt, ~timeout: int) => promise<[#ok | #"not-equal" | #"timed-out"]> = "waitAsync"
+
+  @scope("Atomics") external notify: (TA.t, ~index: int) => int = "notify"
+  @scope("Atomics") external notifyForCount: (TA.t, ~index: int, ~count: int) => int = "notify"
+}
+
+module Int8Array = MakeOps(Js_typed_array2.Int8Array)
+
+module Uint8Array = MakeOps(Js_typed_array2.Uint8Array)
+
+module Int16Array = MakeOps(Js_typed_array2.Int16Array)
+
+module Uint16Array = MakeOps(Js_typed_array2.Uint16Array)
+
+module Int32Array = {
+  include MakeOps(Js_typed_array2.Int32Array)
+  include MakeFutex(Js_typed_array2.Int32Array)
+}
+
+module Uint32Array = MakeOps(Js_typed_array2.Uint32Array)
+
+/** TODO: uncomment this when ready
+module BigInt64Array = {
+  include MakeOps(Js_typed_array2.BigInt64Array)
+  include MakeFutex(Js_typed_array2.BigInt64Array)
+}
+
+module BigUint64Array = MakeOps(Js_typed_array2.BigUint64Array)
+*/
+
+module Float32Array = MakeOps(Js_typed_array2.Float32Array)
+
+module Float64Array = MakeOps(Js_typed_array2.Float64Array)

jscomp/others/js_shared_array_buffer.res

@@ -0,0 +1,29 @@
+@@uncurried
+
+/***
+The underlying buffer that the typed arrays provide views of
+
+**see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer)
+*/
+type t = {
+  byteLength: int,
+  maxByteLength: int,
+  growable: bool,
+}
+
+type makeOptions = {
+  maxByteLength?: int
+}
+
+@new /** takes length. initializes elements to 0 */
+external make: (int, makeOptions) => t = "SharedArrayBuffer"
+let make = (length, ~maxByteLength=?) => make(length, { maxByteLength: ?maxByteLength })
+
+/* ArrayBuffer.isView: seems pointless with a type system */
+
+@get external byteLength: t => int = "byteLength"
+@get external maxByteLength: t => int = "maxByteLength"
+@get external growable: t => bool = "growable"
+
+@send external slice: (t, ~start: int, ~end_: int) => t = "slice"
+@send external sliceFrom: (t, int) => t = "slice"

jscomp/others/js_typed_array.res

@@ -59,11 +59,13 @@ module ArrayBuffer = {
   @bs.send.pipe(: t) external slice: (~start: int, ~end_: int) => array_buffer = "slice" /* FIXME */
   @bs.send.pipe(: t) external sliceFrom: int => array_buffer = "slice"
 }
+
+type typed_array<'a>
+
 module type S = {
   /*** Implements functionality common to all the typed arrays */
 
   type elt
-  type typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -173,7 +175,6 @@ module type S = {
 module Int8Array = {
   /** */
   type elt = int
-  type typed_array<'a> = Js_typed_array2.Int8Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -296,7 +297,6 @@ module Int8Array = {
 module Uint8Array = {
   /** */
   type elt = int
-  type typed_array<'a> = Js_typed_array2.Uint8Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -419,7 +419,6 @@ module Uint8Array = {
 module Uint8ClampedArray = {
   /** */
   type elt = int
-  type typed_array<'a> = Js_typed_array2.Uint8ClampedArray.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -542,7 +541,6 @@ module Uint8ClampedArray = {
 module Int16Array = {
   /** */
   type elt = int
-  type typed_array<'a> = Js_typed_array2.Int16Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -665,7 +663,6 @@ module Int16Array = {
 module Uint16Array = {
   /** */
   type elt = int
-  type typed_array<'a> = Js_typed_array2.Uint16Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -788,7 +785,6 @@ module Uint16Array = {
 module Int32Array = {
   /** */
   type elt = int
-  type typed_array<'a> = Js_typed_array2.Int32Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -914,7 +910,6 @@ module Int32_array = Int32Array
 module Uint32Array = {
   /** */
   type elt = int
-  type typed_array<'a> = Js_typed_array2.Uint32Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -1040,7 +1035,6 @@ module Uint32Array = {
 module Float32Array = {
   /** */
   type elt = float
-  type typed_array<'a> = Js_typed_array2.Float32Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""
@@ -1167,7 +1161,6 @@ module Float32_array = Float32Array
 module Float64Array = {
   /** */
   type elt = float
-  type typed_array<'a> = Js_typed_array2.Float64Array.typed_array<'a>
   type t = typed_array<elt>
 
   @get_index external unsafe_get: (t, int) => elt = ""