@grain/stdlib 0.6.6 → 0.7.1

package/runtime/unsafe/memory.md

@@ -9,42 +9,62 @@ Functions and constants included in the Memory module.
 ### Memory.**malloc**
 
 ```grain
-malloc : (size: WasmI32) => WasmI32
+malloc: (size: WasmI32) => WasmI32
 ```
 
 ### Memory.**free**
 
 ```grain
-free : (userPtr: WasmI32) => Void
+free: (userPtr: WasmI32) => Void
 ```
 
 ### Memory.**incRef**
 
 ```grain
-incRef : (userPtr: WasmI32) => WasmI32
+incRef: (userPtr: WasmI32) => WasmI32
 ```
 
 ### Memory.**decRef**
 
 ```grain
-decRef : (userPtr: WasmI32) => WasmI32
+decRef: (userPtr: WasmI32) => WasmI32
 ```
 
 ### Memory.**copy**
 
 ```grain
-copy : (dest: WasmI32, src: WasmI32, n: WasmI32) => Void
+copy: (dest: WasmI32, src: WasmI32, length: WasmI32) => Void
 ```
 
+Copies the source memory region to the destination memory region. Regions may overlap.
+
+Parameters:
+
+| param    | type      | description                             |
+| -------- | --------- | --------------------------------------- |
+| `dest`   | `WasmI32` | The destination memory region           |
+| `src`    | `WasmI32` | The source memory region                |
+| `length` | `WasmI32` | The length of the memory region to copy |
+
 ### Memory.**fill**
 
 ```grain
-fill : (dest: WasmI32, c: WasmI32, n: WasmI32) => Void
+fill: (dest: WasmI32, value: WasmI32, length: WasmI32) => Void
 ```
 
+Fills the given memory region with the given 1-byte value. Values larger than 1 byte will be truncated.
+
+Parameters:
+
+| param    | type      | description                              |
+| -------- | --------- | ---------------------------------------- |
+| `dest`   | `WasmI32` | The destination memory region            |
+| `value`  | `WasmI32` | The value to fill the memory region with |
+| `length` | `WasmI32` | The length of the memory region to fill  |
+
 ### Memory.**compare**
 
 ```grain
-compare : (ptr1: WasmI32, ptr2: WasmI32, length: WasmI32) => WasmI32
+compare: (ptr1: WasmI32, ptr2: WasmI32, length: WasmI32) => WasmI32
 ```
 

package/runtime/unsafe/offsets.gr

@@ -0,0 +1,36 @@
+/**
+ * Various common offsets for data structures throughout the runtime.
+ */
+@runtimeMode
+module Offsets
+
+// String
+provide let _STR_LEN_OFFSET = 4n
+provide let _STR_DATA_OFFSET = 8n
+
+// Array
+provide let _ARRAY_LEN_OFFSET = 4n
+provide let _ARRAY_DATA_OFFSET = 8n
+provide let _ARRAY_ITEM_SIZE = 4n
+
+// Bytes
+provide let _BYTES_LEN_OFFSET = 4n
+provide let _BYTES_DATA_OFFSET = 8n
+
+// Int32
+provide let _INT32_VALUE_OFFSET = 4n
+
+// Uint32
+provide let _UINT32_VALUE_OFFSET = 4n
+
+// Float32
+provide let _FLOAT32_VALUE_OFFSET = 4n
+
+// Int64
+provide let _INT64_VALUE_OFFSET = 8n
+
+// Uint64
+provide let _UINT64_VALUE_OFFSET = 8n
+
+// Float64
+provide let _FLOAT64_VALUE_OFFSET = 8n

package/runtime/unsafe/offsets.md

@@ -0,0 +1,88 @@
+---
+title: Offsets
+---
+
+Various common offsets for data structures throughout the runtime.
+
+## Values
+
+Functions and constants included in the Offsets module.
+
+### Offsets.**_STR_LEN_OFFSET**
+
+```grain
+_STR_LEN_OFFSET: WasmI32
+```
+
+### Offsets.**_STR_DATA_OFFSET**
+
+```grain
+_STR_DATA_OFFSET: WasmI32
+```
+
+### Offsets.**_ARRAY_LEN_OFFSET**
+
+```grain
+_ARRAY_LEN_OFFSET: WasmI32
+```
+
+### Offsets.**_ARRAY_DATA_OFFSET**
+
+```grain
+_ARRAY_DATA_OFFSET: WasmI32
+```
+
+### Offsets.**_ARRAY_ITEM_SIZE**
+
+```grain
+_ARRAY_ITEM_SIZE: WasmI32
+```
+
+### Offsets.**_BYTES_LEN_OFFSET**
+
+```grain
+_BYTES_LEN_OFFSET: WasmI32
+```
+
+### Offsets.**_BYTES_DATA_OFFSET**
+
+```grain
+_BYTES_DATA_OFFSET: WasmI32
+```
+
+### Offsets.**_INT32_VALUE_OFFSET**
+
+```grain
+_INT32_VALUE_OFFSET: WasmI32
+```
+
+### Offsets.**_UINT32_VALUE_OFFSET**
+
+```grain
+_UINT32_VALUE_OFFSET: WasmI32
+```
+
+### Offsets.**_FLOAT32_VALUE_OFFSET**
+
+```grain
+_FLOAT32_VALUE_OFFSET: WasmI32
+```
+
+### Offsets.**_INT64_VALUE_OFFSET**
+
+```grain
+_INT64_VALUE_OFFSET: WasmI32
+```
+
+### Offsets.**_UINT64_VALUE_OFFSET**
+
+```grain
+_UINT64_VALUE_OFFSET: WasmI32
+```
+
+### Offsets.**_FLOAT64_VALUE_OFFSET**
+
+```grain
+_FLOAT64_VALUE_OFFSET: WasmI32
+```
+

package/runtime/unsafe/panic.gr

@@ -0,0 +1,28 @@
+@runtimeMode
+module Panic
+
+from "runtime/unsafe/wasmi32" include WasmI32
+use WasmI32.{ (+) }
+
+foreign wasm fd_write:
+  (WasmI32, WasmI32, WasmI32, WasmI32) => WasmI32 from "wasi_snapshot_preview1"
+
+primitive unreachable = "@unreachable"
+
+// HACK: Allocate static buffer for printing (40 bytes)
+// Would be nice to have a better way to allocate a static block from
+// the runtime heap, but this is the only module that needs to do it
+let iov = WasmI32.fromGrain([> 0n, 0n, 0n, 0n, 0n, 0n, 0n, 0n, 0n, 0n])
+
+provide let panic = (msg: String) => {
+  let ptr = WasmI32.fromGrain(msg)
+  let written = iov + 32n
+  let lf = iov + 36n
+  WasmI32.store(iov, ptr + 8n, 0n)
+  WasmI32.store(iov, WasmI32.load(ptr, 4n), 4n)
+  WasmI32.store8(lf, 10n, 0n)
+  WasmI32.store(iov, lf, 8n)
+  WasmI32.store(iov, 1n, 12n)
+  fd_write(2n, iov, 2n, written)
+  unreachable()
+}

package/runtime/unsafe/panic.md

@@ -0,0 +1,14 @@
+---
+title: Panic
+---
+
+## Values
+
+Functions and constants included in the Panic module.
+
+### Panic.**panic**
+
+```grain
+panic: (msg: String) => a
+```
+

package/runtime/unsafe/tags.md

@@ -9,192 +9,192 @@ Functions and constants included in the Tags module.
 ### Tags.**_GRAIN_NUMBER_TAG_TYPE**
 
 ```grain
-_GRAIN_NUMBER_TAG_TYPE : WasmI32
+_GRAIN_NUMBER_TAG_TYPE: WasmI32
 ```
 
 ### Tags.**_GRAIN_SHORTVAL_TAG_TYPE**
 
 ```grain
-_GRAIN_SHORTVAL_TAG_TYPE : WasmI32
+_GRAIN_SHORTVAL_TAG_TYPE: WasmI32
 ```
 
 ### Tags.**_GRAIN_CONST_TAG_TYPE**
 
 ```grain
-_GRAIN_CONST_TAG_TYPE : WasmI32
+_GRAIN_CONST_TAG_TYPE: WasmI32
 ```
 
 ### Tags.**_GRAIN_GENERIC_HEAP_TAG_TYPE**
 
 ```grain
-_GRAIN_GENERIC_HEAP_TAG_TYPE : WasmI32
+_GRAIN_GENERIC_HEAP_TAG_TYPE: WasmI32
 ```
 
 ### Tags.**_GRAIN_NUMBER_TAG_MASK**
 
 ```grain
-_GRAIN_NUMBER_TAG_MASK : WasmI32
+_GRAIN_NUMBER_TAG_MASK: WasmI32
 ```
 
 ### Tags.**_GRAIN_GENERIC_TAG_MASK**
 
 ```grain
-_GRAIN_GENERIC_TAG_MASK : WasmI32
+_GRAIN_GENERIC_TAG_MASK: WasmI32
 ```
 
 ### Tags.**_GRAIN_CHAR_SHORTVAL_TAG**
 
 ```grain
-_GRAIN_CHAR_SHORTVAL_TAG : WasmI32
+_GRAIN_CHAR_SHORTVAL_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_INT8_SHORTVAL_TAG**
 
 ```grain
-_GRAIN_INT8_SHORTVAL_TAG : WasmI32
+_GRAIN_INT8_SHORTVAL_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_INT16_SHORTVAL_TAG**
 
 ```grain
-_GRAIN_INT16_SHORTVAL_TAG : WasmI32
+_GRAIN_INT16_SHORTVAL_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_UINT8_SHORTVAL_TAG**
 
 ```grain
-_GRAIN_UINT8_SHORTVAL_TAG : WasmI32
+_GRAIN_UINT8_SHORTVAL_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_UINT16_SHORTVAL_TAG**
 
 ```grain
-_GRAIN_UINT16_SHORTVAL_TAG : WasmI32
+_GRAIN_UINT16_SHORTVAL_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_GENERIC_SHORTVAL_TAG_MASK**
 
 ```grain
-_GRAIN_GENERIC_SHORTVAL_TAG_MASK : WasmI32
+_GRAIN_GENERIC_SHORTVAL_TAG_MASK: WasmI32
 ```
 
 ### Tags.**_GRAIN_INT8_TAG_MASK**
 
 ```grain
-_GRAIN_INT8_TAG_MASK : WasmI32
+_GRAIN_INT8_TAG_MASK: WasmI32
 ```
 
 ### Tags.**_GRAIN_INT16_TAG_MASK**
 
 ```grain
-_GRAIN_INT16_TAG_MASK : WasmI32
+_GRAIN_INT16_TAG_MASK: WasmI32
 ```
 
 ### Tags.**_GRAIN_UINT8_TAG_MASK**
 
 ```grain
-_GRAIN_UINT8_TAG_MASK : WasmI32
+_GRAIN_UINT8_TAG_MASK: WasmI32
 ```
 
 ### Tags.**_GRAIN_UINT16_TAG_MASK**
 
 ```grain
-_GRAIN_UINT16_TAG_MASK : WasmI32
+_GRAIN_UINT16_TAG_MASK: WasmI32
 ```
 
 ### Tags.**_GRAIN_STRING_HEAP_TAG**
 
 ```grain
-_GRAIN_STRING_HEAP_TAG : WasmI32
+_GRAIN_STRING_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_ADT_HEAP_TAG**
 
 ```grain
-_GRAIN_ADT_HEAP_TAG : WasmI32
+_GRAIN_ADT_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_RECORD_HEAP_TAG**
 
 ```grain
-_GRAIN_RECORD_HEAP_TAG : WasmI32
+_GRAIN_RECORD_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_ARRAY_HEAP_TAG**
 
 ```grain
-_GRAIN_ARRAY_HEAP_TAG : WasmI32
+_GRAIN_ARRAY_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_BOXED_NUM_HEAP_TAG**
 
 ```grain
-_GRAIN_BOXED_NUM_HEAP_TAG : WasmI32
+_GRAIN_BOXED_NUM_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_LAMBDA_HEAP_TAG**
 
 ```grain
-_GRAIN_LAMBDA_HEAP_TAG : WasmI32
+_GRAIN_LAMBDA_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_TUPLE_HEAP_TAG**
 
 ```grain
-_GRAIN_TUPLE_HEAP_TAG : WasmI32
+_GRAIN_TUPLE_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_BYTES_HEAP_TAG**
 
 ```grain
-_GRAIN_BYTES_HEAP_TAG : WasmI32
+_GRAIN_BYTES_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_INT32_HEAP_TAG**
 
 ```grain
-_GRAIN_INT32_HEAP_TAG : WasmI32
+_GRAIN_INT32_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_FLOAT32_HEAP_TAG**
 
 ```grain
-_GRAIN_FLOAT32_HEAP_TAG : WasmI32
+_GRAIN_FLOAT32_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_UINT32_HEAP_TAG**
 
 ```grain
-_GRAIN_UINT32_HEAP_TAG : WasmI32
+_GRAIN_UINT32_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_UINT64_HEAP_TAG**
 
 ```grain
-_GRAIN_UINT64_HEAP_TAG : WasmI32
+_GRAIN_UINT64_HEAP_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_FLOAT64_BOXED_NUM_TAG**
 
 ```grain
-_GRAIN_FLOAT64_BOXED_NUM_TAG : WasmI32
+_GRAIN_FLOAT64_BOXED_NUM_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_INT64_BOXED_NUM_TAG**
 
 ```grain
-_GRAIN_INT64_BOXED_NUM_TAG : WasmI32
+_GRAIN_INT64_BOXED_NUM_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_RATIONAL_BOXED_NUM_TAG**
 
 ```grain
-_GRAIN_RATIONAL_BOXED_NUM_TAG : WasmI32
+_GRAIN_RATIONAL_BOXED_NUM_TAG: WasmI32
 ```
 
 ### Tags.**_GRAIN_BIGINT_BOXED_NUM_TAG**
 
 ```grain
-_GRAIN_BIGINT_BOXED_NUM_TAG : WasmI32
+_GRAIN_BIGINT_BOXED_NUM_TAG: WasmI32
 ```
 

package/runtime/unsafe/wasmf32.md

@@ -9,168 +9,168 @@ Functions and constants included in the WasmF32 module.
 ### WasmF32.**load**
 
 ```grain
-load : (ptr: WasmI32, offset: WasmI32) => WasmF32
+load: (ptr: WasmI32, offset: WasmI32) => WasmF32
 ```
 
 ### WasmF32.**store**
 
 ```grain
-store : (ptr: WasmI32, value: WasmF32, offset: WasmI32) => Void
+store: (ptr: WasmI32, value: WasmF32, offset: WasmI32) => Void
 ```
 
 ### WasmF32.**neg**
 
 ```grain
-neg : (num: WasmF32) => WasmF32
+neg: (num: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**abs**
 
 ```grain
-abs : (num: WasmF32) => WasmF32
+abs: (num: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**ceil**
 
 ```grain
-ceil : (num: WasmF32) => WasmF32
+ceil: (num: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**floor**
 
 ```grain
-floor : (num: WasmF32) => WasmF32
+floor: (num: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**trunc**
 
 ```grain
-trunc : (num: WasmF32) => WasmF32
+trunc: (num: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**nearest**
 
 ```grain
-nearest : (num: WasmF32) => WasmF32
+nearest: (num: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**sqrt**
 
 ```grain
-sqrt : (num: WasmF32) => WasmF32
+sqrt: (num: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**(+)**
 
 ```grain
-(+) : (left: WasmF32, right: WasmF32) => WasmF32
+(+): (left: WasmF32, right: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**(-)**
 
 ```grain
-(-) : (left: WasmF32, right: WasmF32) => WasmF32
+(-): (left: WasmF32, right: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**(*)**
 
 ```grain
-(*) : (left: WasmF32, right: WasmF32) => WasmF32
+(*): (left: WasmF32, right: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**(/)**
 
 ```grain
-(/) : (left: WasmF32, right: WasmF32) => WasmF32
+(/): (left: WasmF32, right: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**copySign**
 
 ```grain
-copySign : (left: WasmF32, right: WasmF32) => WasmF32
+copySign: (left: WasmF32, right: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**min**
 
 ```grain
-min : (left: WasmF32, right: WasmF32) => WasmF32
+min: (left: WasmF32, right: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**max**
 
 ```grain
-max : (left: WasmF32, right: WasmF32) => WasmF32
+max: (left: WasmF32, right: WasmF32) => WasmF32
 ```
 
 ### WasmF32.**(==)**
 
 ```grain
-(==) : (left: WasmF32, right: WasmF32) => Bool
+(==): (left: WasmF32, right: WasmF32) => Bool
 ```
 
 ### WasmF32.**(!=)**
 
 ```grain
-(!=) : (left: WasmF32, right: WasmF32) => Bool
+(!=): (left: WasmF32, right: WasmF32) => Bool
 ```
 
 ### WasmF32.**(<)**
 
 ```grain
-(<) : (left: WasmF32, right: WasmF32) => Bool
+(<): (left: WasmF32, right: WasmF32) => Bool
 ```
 
 ### WasmF32.**(<=)**
 
 ```grain
-(<=) : (left: WasmF32, right: WasmF32) => Bool
+(<=): (left: WasmF32, right: WasmF32) => Bool
 ```
 
 ### WasmF32.**(>)**
 
 ```grain
-(>) : (left: WasmF32, right: WasmF32) => Bool
+(>): (left: WasmF32, right: WasmF32) => Bool
 ```
 
 ### WasmF32.**(>=)**
 
 ```grain
-(>=) : (left: WasmF32, right: WasmF32) => Bool
+(>=): (left: WasmF32, right: WasmF32) => Bool
 ```
 
 ### WasmF32.**reinterpretI32**
 
 ```grain
-reinterpretI32 : (num: WasmI32) => WasmF32
+reinterpretI32: (num: WasmI32) => WasmF32
 ```
 
 ### WasmF32.**convertI32S**
 
 ```grain
-convertI32S : (num: WasmI32) => WasmF32
+convertI32S: (num: WasmI32) => WasmF32
 ```
 
 ### WasmF32.**convertI32U**
 
 ```grain
-convertI32U : (num: WasmI32) => WasmF32
+convertI32U: (num: WasmI32) => WasmF32
 ```
 
 ### WasmF32.**convertI64S**
 
 ```grain
-convertI64S : (num: WasmI64) => WasmF32
+convertI64S: (num: WasmI64) => WasmF32
 ```
 
 ### WasmF32.**convertI64U**
 
 ```grain
-convertI64U : (num: WasmI64) => WasmF32
+convertI64U: (num: WasmI64) => WasmF32
 ```
 
 ### WasmF32.**demoteF64**
 
 ```grain
-demoteF64 : (num: WasmF64) => WasmF32
+demoteF64: (num: WasmF64) => WasmF32
 ```