Skip to content

Commit 6b88b9f

Browse files
cometkimcometkim
committed
Add bindings to updated ArrayBuffer, SharedArrayBuffer, and Atomics
1 parent 5a0a21d commit 6b88b9f

18 files changed

+513
-91
lines changed

‎jscomp/others/js.ml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,12 +244,21 @@ module Math = Js_math
244244
module Obj = Js_obj
245245
(** Provide utilities for `Js.t` *)
246246

247+
module ArrayBuffer = Js_array_buffer
248+
(** Provide utilities for `ArrayBuffer` object *)
249+
250+
module SharedArrayBuffer = Js_shared_array_buffer
251+
(** Provide utilities for `SharedArrayBuffer` object *)
252+
247253
module Typed_array = Js_typed_array
248254
(** Provide bindings for JS typed array *)
249255

250256
module TypedArray2 = Js_typed_array2
251257
(** Provide bindings for JS typed array *)
252258

259+
module Atomics = Js_atomics
260+
(** Provide bindings for JS `Atomics` utilities *)
261+
253262
module Types = Js_types
254263
(** Provide utilities for manipulating JS types *)
255264

‎jscomp/others/js_array_buffer.res

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
@@uncurried
2+
3+
/***
4+
The underlying buffer that the typed arrays provide views of
5+
6+
**see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)
7+
*/
8+
type t = {
9+
byteLength: int,
10+
maxByteLength: int,
11+
detached: bool,
12+
resizable: bool,
13+
}
14+
15+
type makeOptions = {
16+
maxByteLength?: int
17+
}
18+
19+
@new /** takes length. initializes elements to 0 */
20+
external make: (int, makeOptions) => t = "ArrayBuffer"
21+
let make = (length, ~maxByteLength=?) => make(length, { maxByteLength: ?maxByteLength })
22+
23+
/* ArrayBuffer.isView: seems pointless with a type system */
24+
25+
@get external byteLength: t => int = "byteLength"
26+
@get external maxByteLength: t => int = "maxByteLength"
27+
@get external detached: t => bool = "detached"
28+
@get external resizable: t => bool = "resizable"
29+
30+
@send external slice: (t, ~start: int, ~end_: int) => t = "slice"
31+
@send external sliceFrom: (t, int) => t = "slice"
32+
33+
@send external transfer: (t, ~newByteLength: int=?) => t = "transfer"
34+
@send external transferToFixedLength: (t, ~newByteLength: int=?) => t = "transferToFixedLength"

‎jscomp/others/js_atomics.res

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
@@uncurried
2+
3+
@scope("Atomics") external isLockFree: int => bool = "isLockFree"
4+
5+
module MakeOps = (TA: Js_typed_array2.S) => {
6+
@scope("Atomics") external add: (TA.t, int, int) => TA.elt = "add"
7+
@scope("Atomics") external sub: (TA.t, int, int) => TA.elt = "sub"
8+
@scope("Atomics") external and_: (TA.t, int, int) => TA.elt = "and"
9+
@scope("Atomics") external or_: (TA.t, int, int) => TA.elt = "or"
10+
@scope("Atomics") external xor: (TA.t, int, int) => TA.elt = "xor"
11+
@scope("Atomics") external load: (TA.t, ~index: int) => TA.elt = "load"
12+
@scope("Atomics") external store: (TA.t, ~index: int, ~value: TA.elt) => TA.elt = "store"
13+
@scope("Atomics") external exchange: (TA.t, ~index: int, ~value: TA.elt) => TA.elt = "exchange"
14+
@scope("Atomics") external compareExchange: (TA.t, ~index: int, ~expectedValue: TA.elt, ~replacementValue: TA.elt) => TA.elt = "compareExchange"
15+
}
16+
17+
module MakeFutex = (TA: Js_typed_array2.S) => {
18+
// These operations are supported only when TA is Int32Array or BigInt64Array, and also underlying buffer is SharedArrayBuffer
19+
20+
@scope("Atomics") external wait: (TA.t, ~index: int, ~value: TA.elt) => [#ok | #"not-equal"] = "wait"
21+
@scope("Atomics") external waitWithTimeout: (TA.t, ~index: int, ~value: TA.elt, ~timeout: int) => [#ok | #"not-equal" | #"timed-out"] = "wait"
22+
23+
@scope("Atomics") external waitAsync: (TA.t, ~index: int, ~value: TA.elt) => promise<[#ok | #"not-equal"]> = "waitAsync"
24+
@scope("Atomics") external waitAsyncWithTimeout: (TA.t, ~index: int, ~value: TA.elt, ~timeout: int) => promise<[#ok | #"not-equal" | #"timed-out"]> = "waitAsync"
25+
26+
@scope("Atomics") external notify: (TA.t, ~index: int) => int = "notify"
27+
@scope("Atomics") external notifyForCount: (TA.t, ~index: int, ~count: int) => int = "notify"
28+
}
29+
30+
module Int8Array = MakeOps(Js_typed_array2.Int8Array)
31+
32+
module Uint8Array = MakeOps(Js_typed_array2.Uint8Array)
33+
34+
module Int16Array = MakeOps(Js_typed_array2.Int16Array)
35+
36+
module Uint16Array = MakeOps(Js_typed_array2.Uint16Array)
37+
38+
module Int32Array = {
39+
include MakeOps(Js_typed_array2.Int32Array)
40+
include MakeFutex(Js_typed_array2.Int32Array)
41+
}
42+
43+
module Uint32Array = MakeOps(Js_typed_array2.Uint32Array)
44+
45+
/** TODO: uncomment this when ready
46+
module BigInt64Array = {
47+
include MakeOps(Js_typed_array2.BigInt64Array)
48+
include MakeFutex(Js_typed_array2.BigInt64Array)
49+
}
50+
51+
module BigUint64Array = MakeOps(Js_typed_array2.BigUint64Array)
52+
*/
53+
54+
module Float32Array = MakeOps(Js_typed_array2.Float32Array)
55+
56+
module Float64Array = MakeOps(Js_typed_array2.Float64Array)

‎jscomp/others/js_shared_array_buffer.res

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
@@uncurried
2+
3+
/***
4+
The underlying buffer that the typed arrays provide views of
5+
6+
**see** [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer)
7+
*/
8+
type t = {
9+
byteLength: int,
10+
maxByteLength: int,
11+
growable: bool,
12+
}
13+
14+
type makeOptions = {
15+
maxByteLength?: int
16+
}
17+
18+
@new /** takes length. initializes elements to 0 */
19+
external make: (int, makeOptions) => t = "SharedArrayBuffer"
20+
let make = (length, ~maxByteLength=?) => make(length, { maxByteLength: ?maxByteLength })
21+
22+
/* ArrayBuffer.isView: seems pointless with a type system */
23+
24+
@get external byteLength: t => int = "byteLength"
25+
@get external maxByteLength: t => int = "maxByteLength"
26+
@get external growable: t => bool = "growable"
27+
28+
@send external slice: (t, ~start: int, ~end_: int) => t = "slice"
29+
@send external sliceFrom: (t, int) => t = "slice"

‎jscomp/others/js_typed_array.res

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ module type S = {
173173
module Int8Array = {
174174
/** */
175175
type elt = int
176-
type typed_array<'a> = Js_typed_array2.Int8Array.typed_array<'a>
176+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
177177
type t = typed_array<elt>
178178

179179
@get_index external unsafe_get: (t, int) => elt = ""
@@ -296,7 +296,7 @@ module Int8Array = {
296296
module Uint8Array = {
297297
/** */
298298
type elt = int
299-
type typed_array<'a> = Js_typed_array2.Uint8Array.typed_array<'a>
299+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
300300
type t = typed_array<elt>
301301

302302
@get_index external unsafe_get: (t, int) => elt = ""
@@ -419,7 +419,7 @@ module Uint8Array = {
419419
module Uint8ClampedArray = {
420420
/** */
421421
type elt = int
422-
type typed_array<'a> = Js_typed_array2.Uint8ClampedArray.typed_array<'a>
422+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
423423
type t = typed_array<elt>
424424

425425
@get_index external unsafe_get: (t, int) => elt = ""
@@ -542,7 +542,7 @@ module Uint8ClampedArray = {
542542
module Int16Array = {
543543
/** */
544544
type elt = int
545-
type typed_array<'a> = Js_typed_array2.Int16Array.typed_array<'a>
545+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
546546
type t = typed_array<elt>
547547

548548
@get_index external unsafe_get: (t, int) => elt = ""
@@ -665,7 +665,7 @@ module Int16Array = {
665665
module Uint16Array = {
666666
/** */
667667
type elt = int
668-
type typed_array<'a> = Js_typed_array2.Uint16Array.typed_array<'a>
668+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
669669
type t = typed_array<elt>
670670

671671
@get_index external unsafe_get: (t, int) => elt = ""
@@ -788,7 +788,7 @@ module Uint16Array = {
788788
module Int32Array = {
789789
/** */
790790
type elt = int
791-
type typed_array<'a> = Js_typed_array2.Int32Array.typed_array<'a>
791+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
792792
type t = typed_array<elt>
793793

794794
@get_index external unsafe_get: (t, int) => elt = ""
@@ -914,7 +914,7 @@ module Int32_array = Int32Array
914914
module Uint32Array = {
915915
/** */
916916
type elt = int
917-
type typed_array<'a> = Js_typed_array2.Uint32Array.typed_array<'a>
917+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
918918
type t = typed_array<elt>
919919

920920
@get_index external unsafe_get: (t, int) => elt = ""
@@ -1040,7 +1040,7 @@ module Uint32Array = {
10401040
module Float32Array = {
10411041
/** */
10421042
type elt = float
1043-
type typed_array<'a> = Js_typed_array2.Float32Array.typed_array<'a>
1043+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
10441044
type t = typed_array<elt>
10451045

10461046
@get_index external unsafe_get: (t, int) => elt = ""
@@ -1167,7 +1167,7 @@ module Float32_array = Float32Array
11671167
module Float64Array = {
11681168
/** */
11691169
type elt = float
1170-
type typed_array<'a> = Js_typed_array2.Float64Array.typed_array<'a>
1170+
type typed_array<'a> = Js_typed_array2.typed_array<'a>
11711171
type t = typed_array<elt>
11721172

11731173
@get_index external unsafe_get: (t, int) => elt = ""

0 commit comments

Comments
 (0)