@grain/stdlib 0.5.13 → 0.6.0

package/runtime/dataStructures.md

@@ -1,7 +1,15 @@
+---
+title: DataStructures
+---
+
+## Values
+
+Functions and constants included in the DataStructures module.
+
 ### DataStructures.**allocateArray**
 
 ```grain
-allocateArray : WasmI32 -> WasmI32
+allocateArray : (size: WasmI32) => WasmI32
 ```
 
 Allocates a new Grain array.
@@ -10,7 +18,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`numElts`|`WasmI32`|The number of elements to be contained in this array|
+|`size`|`WasmI32`|The number of elements to be contained in this array|
 
 Returns:
 
@@ -21,7 +29,7 @@ Returns:
 ### DataStructures.**allocateTuple**
 
 ```grain
-allocateTuple : WasmI32 -> WasmI32
+allocateTuple : (size: WasmI32) => WasmI32
 ```
 
 Allocates a new Grain tuple.
@@ -30,7 +38,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`numElts`|`WasmI32`|The number of elements to be contained in this tuple|
+|`size`|`WasmI32`|The number of elements to be contained in this tuple|
 
 Returns:
 
@@ -41,7 +49,7 @@ Returns:
 ### DataStructures.**allocateBytes**
 
 ```grain
-allocateBytes : WasmI32 -> WasmI32
+allocateBytes : (size: WasmI32) => WasmI32
 ```
 
 Allocates a new Grain bytes.
@@ -61,7 +69,7 @@ Returns:
 ### DataStructures.**allocateString**
 
 ```grain
-allocateString : WasmI32 -> WasmI32
+allocateString : (size: WasmI32) => WasmI32
 ```
 
 Allocates a new Grain string.
@@ -81,7 +89,7 @@ Returns:
 ### DataStructures.**allocateInt32**
 
 ```grain
-allocateInt32 : () -> WasmI32
+allocateInt32 : () => WasmI32
 ```
 
 Allocates a new Int32.
@@ -95,7 +103,7 @@ Returns:
 ### DataStructures.**newInt32**
 
 ```grain
-newInt32 : WasmI32 -> WasmI32
+newInt32 : (int: WasmI32) => WasmI32
 ```
 
 Allocates a new Int32 with a prepopulated value
@@ -104,7 +112,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`WasmI32`|The value to store|
+|`int`|`WasmI32`|The value to store|
 
 Returns:
 
@@ -112,10 +120,44 @@ Returns:
 |----|-----------|
 |`WasmI32`|The pointer to the Int32|
 
+### DataStructures.**allocateUint32**
+
+```grain
+allocateUint32 : () => WasmI32
+```
+
+Allocates a new Uint32.
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The pointer to the empty Uint32|
+
+### DataStructures.**newUint32**
+
+```grain
+newUint32 : (int: WasmI32) => WasmI32
+```
+
+Allocates a new Uint32 with a prepopulated value
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`WasmI32`|The value to store|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The pointer to the Uint32|
+
 ### DataStructures.**allocateInt64**
 
 ```grain
-allocateInt64 : () -> WasmI32
+allocateInt64 : () => WasmI32
 ```
 
 Allocates a new Int64.
@@ -129,7 +171,7 @@ Returns:
 ### DataStructures.**newInt64**
 
 ```grain
-newInt64 : WasmI64 -> WasmI32
+newInt64 : (int: WasmI64) => WasmI32
 ```
 
 Allocates a new Int64 with a prepopulated value
@@ -138,7 +180,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`WasmI64`|The value to store|
+|`int`|`WasmI64`|The value to store|
 
 Returns:
 
@@ -146,10 +188,44 @@ Returns:
 |----|-----------|
 |`WasmI32`|The pointer to the Int64|
 
+### DataStructures.**allocateUint64**
+
+```grain
+allocateUint64 : () => WasmI32
+```
+
+Allocates a new Uint64.
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The pointer to the empty Uint64|
+
+### DataStructures.**newUint64**
+
+```grain
+newUint64 : (int: WasmI64) => WasmI32
+```
+
+Allocates a new Uint64 with a prepopulated value
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`WasmI64`|The value to store|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The pointer to the Uint64|
+
 ### DataStructures.**allocateFloat32**
 
 ```grain
-allocateFloat32 : () -> WasmI32
+allocateFloat32 : () => WasmI32
 ```
 
 Allocates a new Float32.
@@ -163,7 +239,7 @@ Returns:
 ### DataStructures.**newFloat32**
 
 ```grain
-newFloat32 : WasmF32 -> WasmI32
+newFloat32 : (float: WasmF32) => WasmI32
 ```
 
 Allocates a new Float32 with a prepopulated value
@@ -172,7 +248,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`WasmF32`|The value to store|
+|`float`|`WasmF32`|The value to store|
 
 Returns:
 
@@ -183,7 +259,7 @@ Returns:
 ### DataStructures.**allocateFloat64**
 
 ```grain
-allocateFloat64 : () -> WasmI32
+allocateFloat64 : () => WasmI32
 ```
 
 Allocates a new Float64.
@@ -197,7 +273,7 @@ Returns:
 ### DataStructures.**newFloat64**
 
 ```grain
-newFloat64 : WasmF64 -> WasmI32
+newFloat64 : (float: WasmF64) => WasmI32
 ```
 
 Allocates a new Float64 with a prepopulated value
@@ -206,7 +282,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`WasmF64`|The value to store|
+|`float`|`WasmF64`|The value to store|
 
 Returns:
 
@@ -217,7 +293,7 @@ Returns:
 ### DataStructures.**allocateRational**
 
 ```grain
-allocateRational : () -> WasmI32
+allocateRational : () => WasmI32
 ```
 
 Allocates a new Rational.
@@ -231,7 +307,7 @@ Returns:
 ### DataStructures.**newRational**
 
 ```grain
-newRational : (WasmI32, WasmI32) -> WasmI32
+newRational : (numerator: WasmI32, denominator: WasmI32) => WasmI32
 ```
 
 Allocates a new Rational with a prepopulated value
@@ -240,8 +316,8 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`WasmI32`|The numerator value to store|
-|`value`|`WasmI32`|The denominator value to store|
+|`numerator`|`WasmI32`|The numerator value to store|
+|`denominator`|`WasmI32`|The denominator value to store|
 
 Returns:
 
@@ -252,7 +328,7 @@ Returns:
 ### DataStructures.**loadAdtVariant**
 
 ```grain
-loadAdtVariant : WasmI32 -> WasmI32
+loadAdtVariant : (ptr: WasmI32) => WasmI32
 ```
 
 Load the (tagged) variant of an ADT.
@@ -272,7 +348,7 @@ Returns:
 ### DataStructures.**stringSize**
 
 ```grain
-stringSize : WasmI32 -> WasmI32
+stringSize : (ptr: WasmI32) => WasmI32
 ```
 
 Load an untagged string's size.
@@ -292,7 +368,7 @@ Returns:
 ### DataStructures.**bytesSize**
 
 ```grain
-bytesSize : WasmI32 -> WasmI32
+bytesSize : (ptr: WasmI32) => WasmI32
 ```
 
 Load an untagged Bytes' size.
@@ -312,7 +388,7 @@ Returns:
 ### DataStructures.**tagSimpleNumber**
 
 ```grain
-tagSimpleNumber : WasmI32 -> Number
+tagSimpleNumber : (num: WasmI32) => Number
 ```
 
 Tag a simple number.
@@ -332,7 +408,7 @@ Returns:
 ### DataStructures.**untagSimpleNumber**
 
 ```grain
-untagSimpleNumber : Number -> WasmI32
+untagSimpleNumber : (num: Number) => WasmI32
 ```
 
 Untag a simple number.
@@ -352,7 +428,7 @@ Returns:
 ### DataStructures.**tagChar**
 
 ```grain
-tagChar : WasmI32 -> Char
+tagChar : (char: WasmI32) => Char
 ```
 
 Tag a char.
@@ -361,7 +437,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`num`|`WasmI32`|The usv to tag|
+|`char`|`WasmI32`|The usv to tag|
 
 Returns:
 
@@ -372,7 +448,7 @@ Returns:
 ### DataStructures.**untagChar**
 
 ```grain
-untagChar : Char -> WasmI32
+untagChar : (char: Char) => WasmI32
 ```
 
 Untag a char.
@@ -381,7 +457,7 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`num`|`Char`|The char to untag|
+|`char`|`Char`|The char to untag|
 
 Returns:
 
@@ -389,3 +465,163 @@ Returns:
 |----|-----------|
 |`WasmI32`|The untagged usv|
 
+### DataStructures.**tagInt8**
+
+```grain
+tagInt8 : (int: WasmI32) => Int8
+```
+
+Tag an int8.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`WasmI32`|The int8 to tag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Int8`|The tagged int8|
+
+### DataStructures.**untagInt8**
+
+```grain
+untagInt8 : (int: Int8) => WasmI32
+```
+
+Untag an int8.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`Int8`|The int8 to untag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The untagged int8|
+
+### DataStructures.**tagInt16**
+
+```grain
+tagInt16 : (int: WasmI32) => Int16
+```
+
+Tag an int16.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`WasmI32`|The int16 to tag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Int16`|The tagged int16|
+
+### DataStructures.**untagInt16**
+
+```grain
+untagInt16 : (int: Int16) => WasmI32
+```
+
+Untag an int16.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`Int16`|The int16 to untag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The untagged int16|
+
+### DataStructures.**tagUint8**
+
+```grain
+tagUint8 : (int: WasmI32) => Uint8
+```
+
+Tag a uint8.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`WasmI32`|The uint8 to tag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Uint8`|The tagged uint8|
+
+### DataStructures.**untagUint8**
+
+```grain
+untagUint8 : (int: Uint8) => WasmI32
+```
+
+Untag a uint8.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`Uint8`|The uint8 to untag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The untagged uint8|
+
+### DataStructures.**tagUint16**
+
+```grain
+tagUint16 : (int: WasmI32) => Uint16
+```
+
+Tag a uint16.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`WasmI32`|The uint16 to tag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Uint16`|The tagged uint16|
+
+### DataStructures.**untagUint16**
+
+```grain
+untagUint16 : (int: Uint16) => WasmI32
+```
+
+Untag a uint16.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`int`|`Uint16`|The uint16 to untag|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`WasmI32`|The untagged uint16|
+

package/runtime/debugPrint.gr

@@ -1,17 +1,16 @@
-import Utils from "runtime/numberUtils"
-import WasmI32, { add as (+) } from "runtime/unsafe/wasmi32"
-import WasmF64 from "runtime/unsafe/wasmf64"
-import Memory from "runtime/unsafe/memory"
+module DebugPrint
 
-import foreign wasm fd_write: (
-  WasmI32,
-  WasmI32,
-  WasmI32,
-  WasmI32,
-) -> WasmI32 from "wasi_snapshot_preview1"
+from "runtime/numberUtils" include NumberUtils as Utils
+from "runtime/unsafe/wasmi32" include WasmI32
+use WasmI32.{ (+) }
+from "runtime/unsafe/wasmf64" include WasmF64
+from "runtime/unsafe/memory" include Memory
+
+foreign wasm fd_write:
+  (WasmI32, WasmI32, WasmI32, WasmI32) => WasmI32 from "wasi_snapshot_preview1"
 
 @unsafe
-export let print = (s: String) => {
+provide let print = (s: String) => {
   let ptr = WasmI32.fromGrain(s)
   // iov: [<ptr to string> <nbytes of string> <ptr to newline> <nbytes of newline>] (32 bytes)
   // buf: <iov> <written> <newline char>
@@ -31,21 +30,41 @@ export let print = (s: String) => {
 }
 
 @unsafe
-export let printI32 = val => {
+provide let printI32 = val => {
   print(Utils.itoa32(val, 10n))
 }
 
 @unsafe
-export let printI64 = val => {
+provide let printI64 = val => {
   print(Utils.itoa64(val, 10n))
 }
 
 @unsafe
-export let printF32 = val => {
+provide let printF32 = val => {
   print(Utils.dtoa(WasmF64.promoteF32(val)))
 }
 
 @unsafe
-export let printF64 = val => {
+provide let printF64 = val => {
   print(Utils.dtoa(val))
 }
+
+@unsafe
+provide let toStringI32 = val => {
+  Utils.itoa32(val, 10n)
+}
+
+@unsafe
+provide let toStringI64 = val => {
+  Utils.itoa64(val, 10n)
+}
+
+@unsafe
+provide let toStringF32 = val => {
+  Utils.dtoa(WasmF64.promoteF32(val))
+}
+
+@unsafe
+provide let toStringF64 = val => {
+  Utils.dtoa(val)
+}

package/runtime/debugPrint.md

@@ -1,30 +1,62 @@
+---
+title: DebugPrint
+---
+
+## Values
+
+Functions and constants included in the DebugPrint module.
+
 ### DebugPrint.**print**
 
 ```grain
-print : String -> Void
+print : (s: String) => Void
 ```
 
 ### DebugPrint.**printI32**
 
 ```grain
-printI32 : WasmI32 -> Void
+printI32 : (val: WasmI32) => Void
 ```
 
 ### DebugPrint.**printI64**
 
 ```grain
-printI64 : WasmI64 -> Void
+printI64 : (val: WasmI64) => Void
 ```
 
 ### DebugPrint.**printF32**
 
 ```grain
-printF32 : WasmF32 -> Void
+printF32 : (val: WasmF32) => Void
 ```
 
 ### DebugPrint.**printF64**
 
 ```grain
-printF64 : WasmF64 -> Void
+printF64 : (val: WasmF64) => Void
+```
+
+### DebugPrint.**toStringI32**
+
+```grain
+toStringI32 : (val: WasmI32) => String
+```
+
+### DebugPrint.**toStringI64**
+
+```grain
+toStringI64 : (val: WasmI64) => String
+```
+
+### DebugPrint.**toStringF32**
+
+```grain
+toStringF32 : (val: WasmF32) => String
+```
+
+### DebugPrint.**toStringF64**
+
+```grain
+toStringF64 : (val: WasmF64) => String
 ```