@grain/stdlib 0.4.2 → 0.4.6

package/array.md

@@ -263,6 +263,27 @@ Returns:
 |----|-----------|
 |`Array<a>`|The new array containing the elements from the input|
 
+### Array.**cycle**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+cycle : ((a -> Void), Number, Array<a>) -> Void
+```
+
+Iterates an array a given number of times, calling an iterator function on each element.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`fn`|`a -> Void`|The iterator function to call with each element|
+|`n`|`Number`|The number of times to iterate the given array|
+|`array`|`Array<a>`|The array to iterate|
+
 ### Array.**forEach**
 
 <details>
@@ -350,7 +371,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Array<a>`|The new array with mapped values|
+|`Array<b>`|The new array with mapped values|
 
 ### Array.**mapi**
 
@@ -377,7 +398,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Array<a>`|The new array with mapped values|
+|`Array<b>`|The new array with mapped values|
 
 ### Array.**reduce**
 
@@ -404,7 +425,7 @@ Parameters:
 |-----|----|-----------|
 |`fn`|`(a, b) -> a`|The reducer function to call on each element, where the value returned will be the next accumulator value|
 |`initial`|`a`|The initial value to use for the accumulator on the first iteration|
-|`array`|`Array<a>`|The array to iterate|
+|`array`|`Array<b>`|The array to iterate|
 
 Returns:
 
@@ -444,7 +465,7 @@ Parameters:
 |-----|----|-----------|
 |`fn`|`(a, b, Number) -> a`|The reducer function to call on each element, where the value returned will be the next accumulator value|
 |`initial`|`a`|The initial value to use for the accumulator on the first iteration|
-|`array`|`Array<a>`|The array to iterate|
+|`array`|`Array<b>`|The array to iterate|
 
 Returns:
 
@@ -479,7 +500,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Array<a>`|The new array|
+|`Array<b>`|The new array|
 
 ### Array.**every**
 
@@ -1006,3 +1027,58 @@ Returns:
 |----|-----------|
 |`Array<a>`|The subset of the array that was sliced|
 
+### Array.**sort**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+sort : (((a, a) -> Number), Array<a>) -> Void
+```
+
+Sorts an array in-place.
+
+Ordering is calculated using a comparator function which takes two array elements and must return 0 if both are equal, a positive number if the first is greater, and a negative number if the first is smaller.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`comp`|`(a, a) -> Number`|The comparator function used to indicate sort order|
+|`array`|`Array<a>`|The array to be sorted|
+
+### Array.**rotate**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>next</code></summary>
+No other changes yet.
+</details>
+
+```grain
+rotate : (Number, Array<a>) -> Void
+```
+
+Rotates an array by n elements to the right, in place.
+
+If n is negative, the array will be rotated by n elements
+to the left. See examples.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`n`|`Number`|The number of elements to rotate by|
+|`arr`|`Array<a>`|The array to be rotated|
+
+Examples:
+
+```grain
+let array = [> 1, 2, 3, 4, 5]; rotate(2, arr); arr == [> 4, 5, 1, 2, 3]
+```
+
+```grain
+let array = [> 1, 2, 3, 4, 5]; rotate(-1, arr); arr == [> 2, 3, 4, 5, 1]
+```
+

package/buffer.gr

@@ -23,17 +23,17 @@ record Buffer {
 }
 
 @disableGC
-let mut _SIZE_OFFSET = 1n;
+let mut _SIZE_OFFSET = 1n
 
 @disableGC
-let mut _VALUE_OFFSET = 1n;
+let mut _VALUE_OFFSET = 1n
 
 @disableGC
 let initOffsets = () => {
-  _SIZE_OFFSET = 4n;
-  _VALUE_OFFSET = 8n;
+  _SIZE_OFFSET = 4n
+  _VALUE_OFFSET = 8n
 }
-initOffsets();
+initOffsets()
 
 let _8BIT_LEN = 1
 
@@ -45,27 +45,28 @@ let _64BIT_LEN = 8
 
 /* Gets the size of a Bytes via its ptr */
 @disableGC
-let getSize = (ptr) => WasmI32.load(ptr, _SIZE_OFFSET)
+let getSize = ptr => WasmI32.load(ptr, _SIZE_OFFSET)
 
 /* Doubles the size of buffer's underlying byte sequence, if the given size is larger than the size of a buffer's underlying byte sequence */
 let autogrow = (len, buf) => {
   while (buf.len + len > Bytes.length(buf.data)) {
     let mut n = Bytes.length(buf.data)
-    if (n == 0) n = 4 // Make sure bytes of 0 length grow too
+    if (n == 0) n = 4
+    // Make sure bytes of 0 length grow too
     buf.data = Bytes.resize(0, n, buf.data)
   }
 }
 
 /* Gets the pointer for a char's bytes following the char's tag */
 @disableGC
-let rec getCharAsWasmI32 = (char) => {
+let rec getCharAsWasmI32 = char => {
   let c = WasmI32.fromGrain(char)
   WasmI32.load(c, 4n)
 }
 
 /* Gets the UTF-8 byte length of a char */
 @disableGC
-let rec getCharByteLength = (byte) => {
+let rec getCharByteLength = byte => {
   let (+) = WasmI32.add
   let (&) = WasmI32.and
   let (==) = WasmI32.eq
@@ -132,13 +133,10 @@ let addInt32help = (value, buffer) => {
  *
  * @since v0.4.0
  */
-export let make = (initialSize) => {
-  if (initialSize < 0) throw Exception.InvalidArgument("Buffers size must be >= 0")
-  {
-    len: 0,
-    initialSize,
-    data: Bytes.make(initialSize),
-  }
+export let make = initialSize => {
+  if (initialSize < 0)
+    throw Exception.InvalidArgument("Buffers size must be >= 0")
+  { len: 0, initialSize, data: Bytes.make(initialSize) }
 }
 
 /**
@@ -149,7 +147,7 @@ export let make = (initialSize) => {
  *
  * @since v0.4.0
  */
-export let length = (buffer) => buffer.len
+export let length = buffer => buffer.len
 
 /**
  * Clears data in the buffer and sets its length to zero.
@@ -160,7 +158,7 @@ export let length = (buffer) => buffer.len
  *
  * @since v0.4.0
  */
-export let clear = (buffer) => {
+export let clear = buffer => {
   Bytes.fill(0x0l, buffer.data)
   buffer.len = 0
 }
@@ -174,7 +172,7 @@ export let clear = (buffer) => {
  *
  * @since v0.4.0
  */
-export let reset = (buffer) => {
+export let reset = buffer => {
   buffer.data = Bytes.make(buffer.initialSize)
   buffer.len = 0
 }
@@ -192,7 +190,6 @@ export let reset = (buffer) => {
 @disableGC
 export let rec truncate = (length, buffer) => {
   Memory.incRef(WasmI32.fromGrain((<)))
-  Memory.incRef(WasmI32.fromGrain((||)))
   Memory.incRef(WasmI32.fromGrain((>)))
   if (length < 0 || length > buffer.len) throw Exception.IndexOutOfBounds
 
@@ -217,7 +214,7 @@ export let rec truncate = (length, buffer) => {
  *
  * @since v0.4.0
  */
-export let toBytes = (buffer) => {
+export let toBytes = buffer => {
   let len = Bytes.length(buffer.data)
   if (buffer.len == len) {
     buffer.data
@@ -249,7 +246,7 @@ export let toBytesSlice = (start, length, buffer) => {
  *
  * @since v0.4.0
  */
-export let toString = (buffer) => {
+export let toString = buffer => {
   Bytes.toString(toBytes(buffer))
 }
 
@@ -286,6 +283,8 @@ export let rec addChar = (char: Char, buffer: Buffer) => {
       Memory.incRef(WasmI32.fromGrain(c))
       Memory.incRef(WasmI32.fromGrain(buffer))
       addInt8help(c, buffer)
+      Memory.decRef(WasmI32.fromGrain(c))
+      void
     },
     2n => {
       let c = Conv.toInt32(n)
@@ -293,6 +292,8 @@ export let rec addChar = (char: Char, buffer: Buffer) => {
       Memory.incRef(WasmI32.fromGrain(c))
       Memory.incRef(WasmI32.fromGrain(buffer))
       addInt16help(c, buffer)
+      Memory.decRef(WasmI32.fromGrain(c))
+      void
     },
     3n => {
       let (<) = WasmI32.ltU
@@ -300,12 +301,14 @@ export let rec addChar = (char: Char, buffer: Buffer) => {
       let (*) = WasmI32.mul
       let (&) = WasmI32.and
       let (>>) = WasmI32.shrU
-      for (let mut i = 0n; i < 3n; i = i + 1n) {
-        let c = Conv.toInt32(n >> (i * 8n) & 0xffn)
+      for (let mut i = 0n; i < 3n; i += 1n) {
+        let c = Conv.toInt32(n >> i * 8n & 0xffn)
         Memory.incRef(WasmI32.fromGrain(addInt8help))
         Memory.incRef(WasmI32.fromGrain(c))
         Memory.incRef(WasmI32.fromGrain(buffer))
         addInt8help(c, buffer)
+        Memory.decRef(WasmI32.fromGrain(c))
+        void
       }
     },
     _ => {
@@ -314,6 +317,8 @@ export let rec addChar = (char: Char, buffer: Buffer) => {
       Memory.incRef(WasmI32.fromGrain(c))
       Memory.incRef(WasmI32.fromGrain(buffer))
       addInt32help(c, buffer)
+      Memory.decRef(WasmI32.fromGrain(c))
+      void
     },
   }
 
@@ -406,28 +411,58 @@ export let rec addString = (string, buffer) => {
  * @since v0.4.0
  */
 @disableGC
-export let rec addStringSlice = (start, length, string, buffer) => {
-  Memory.incRef(WasmI32.fromGrain(String.byteLength))
-  Memory.incRef(WasmI32.fromGrain(start))
-  Memory.incRef(WasmI32.fromGrain(length))
+export let rec addStringSlice = (start: Number, length, string, buffer) => {
+  // Handle negative start index (needed before #1071 is fixed)
+  let start = {
+    // this is a block to avoid making all of these operators
+    // overriden in the whole function
+    let (<<) = WasmI32.shl
+    let (>>) = WasmI32.shrS
+    let (+) = WasmI32.add
+    let (!=) = WasmI32.ne
+    let (&) = WasmI32.and
+    Memory.incRef(WasmI32.fromGrain(String.length))
+    Memory.incRef(WasmI32.fromGrain(string))
+    let strlen = WasmI32.fromGrain(String.length(string)) >> 1n
+    let mut startW = WasmI32.fromGrain(start)
+    if ((startW & 1n) != 1n) {
+      throw InvalidArgument("Invalid start index")
+    }
+    startW = startW >> 1n
+    if (WasmI32.ltS(startW, 0n)) {
+      WasmI32.toGrain(WasmI32.shl(startW + strlen, 1n) + 1n)
+    } else {
+      start
+    }
+  }
+  let end = start + length
+  Memory.incRef(WasmI32.fromGrain(String.slice))
+  // no incref for start since we know it's a simple num. Add back for good measure after #1071 is fixed!
+  Memory.incRef(WasmI32.fromGrain(end))
   Memory.incRef(WasmI32.fromGrain(string))
-  let bytelen = String.byteLength(String.slice(start, length, string))
+  let slice = String.slice(start, end, string)
+
+  Memory.incRef(WasmI32.fromGrain(String.byteLength))
+  Memory.incRef(WasmI32.fromGrain(slice))
+  let bytelen = String.byteLength(slice)
 
   Memory.incRef(WasmI32.fromGrain(autogrow))
   Memory.incRef(WasmI32.fromGrain(bytelen))
   Memory.incRef(WasmI32.fromGrain(buffer))
   autogrow(bytelen, buffer)
 
-  let srcOff = coerceNumberToWasmI32(start)
+  let srcOff = 0n
   let dstOff = coerceNumberToWasmI32(buffer.len)
-  let src = WasmI32.fromGrain(string)
+  let src = WasmI32.fromGrain(slice)
   let dst = WasmI32.fromGrain(buffer.data)
   appendBytes(srcOff, dstOff, coerceNumberToWasmI32(bytelen), src, dst)
+  Memory.decRef(WasmI32.fromGrain(slice))
 
   Memory.incRef(WasmI32.fromGrain((+)))
   Memory.incRef(WasmI32.fromGrain(buffer.len))
   Memory.incRef(WasmI32.fromGrain(bytelen))
   buffer.len = buffer.len + bytelen
+  Memory.decRef(WasmI32.fromGrain(bytelen))
 
   Memory.decRef(WasmI32.fromGrain(start))
   Memory.decRef(WasmI32.fromGrain(length))
@@ -448,17 +483,40 @@ export let rec addStringSlice = (start, length, string, buffer) => {
  * @since v0.4.0
  */
 @disableGC
-export let rec addBytesSlice = (start: Number, length: Number, bytes: Bytes, buffer: Buffer) => {
+export let rec addBytesSlice =
+  (
+    start: Number,
+    length: Number,
+    bytes: Bytes,
+    buffer: Buffer,
+  ) => {
+  let (-) = WasmI32.sub
+  let (<) = WasmI32.ltS
+  let (>) = WasmI32.gtS
+  let (>=) = WasmI32.geS
+
+  // bounds check start
+  let bytelen = WasmI32.load(WasmI32.fromGrain(bytes), 4n)
+  let srcOff = coerceNumberToWasmI32(start)
+  if (srcOff < 0n || srcOff >= bytelen) {
+    throw Exception.IndexOutOfBounds
+  }
+
+  // bounds check length
+  let len = coerceNumberToWasmI32(length)
+  if (len < 0n || len > bytelen - srcOff) {
+    throw Exception.IndexOutOfBounds
+  }
+
   Memory.incRef(WasmI32.fromGrain(autogrow))
   Memory.incRef(WasmI32.fromGrain(length))
   Memory.incRef(WasmI32.fromGrain(buffer))
   autogrow(length, buffer)
 
-  let srcOff = coerceNumberToWasmI32(start)
   let dstOff = coerceNumberToWasmI32(buffer.len)
   let src = WasmI32.fromGrain(bytes)
   let dst = WasmI32.fromGrain(buffer.data)
-  appendBytes(srcOff, dstOff, coerceNumberToWasmI32(length), src, dst)
+  appendBytes(srcOff, dstOff, len, src, dst)
 
   Memory.incRef(WasmI32.fromGrain((+)))
   Memory.incRef(WasmI32.fromGrain(buffer.len))
@@ -507,7 +565,6 @@ export let addBufferSlice = (start, length, srcBuffer, dstBuffer) => {
  * @section Binary operations on integers: Functions for encoding and decoding integers stored in a buffer.
  */
 
-
 /**
  * Gets a signed 8-bit integer starting at the given byte index.
  *
@@ -783,4 +840,4 @@ export let addFloat64 = (value, buffer) => {
   let index = buffer.len
   buffer.len = buffer.len + _64BIT_LEN
   setFloat64(index, value, buffer)
-}
+}

package/bytes.gr

@@ -15,7 +15,7 @@ import Conv from "runtime/unsafe/conv"
 import {
   tagSimpleNumber,
   allocateBytes,
-  allocateString
+  allocateString,
 } from "runtime/dataStructures"
 import Exception from "runtime/exception"
 import Int32 from "int32"
@@ -85,7 +85,7 @@ let getSize = ptr => WasmI32.load(ptr, _SIZE_OFFSET)
 @disableGC
 export let rec make = (size: Number) => {
   let bytes = allocateBytes(coerceNumberToWasmI32(size))
-  let ret = WasmI32.toGrain(bytes): (Bytes)
+  let ret = WasmI32.toGrain(bytes): Bytes
   Memory.decRef(WasmI32.fromGrain(size))
   Memory.decRef(WasmI32.fromGrain(make))
   ret
@@ -113,7 +113,7 @@ export let rec fromString = (string: String) => {
   let size = getSize(src)
   let dst = allocateBytes(size)
   Memory.copy(dst + _VALUE_OFFSET, src + _VALUE_OFFSET, size)
-  let ret = WasmI32.toGrain(dst): (Bytes)
+  let ret = WasmI32.toGrain(dst): Bytes
   Memory.decRef(WasmI32.fromGrain(string))
   Memory.decRef(WasmI32.fromGrain(fromString))
   ret
@@ -134,7 +134,7 @@ export let rec toString = (bytes: Bytes) => {
   let size = getSize(src)
   let dst = allocateString(size)
   Memory.copy(dst + _VALUE_OFFSET, src + _VALUE_OFFSET, size)
-  let ret = WasmI32.toGrain(dst): (String)
+  let ret = WasmI32.toGrain(dst): String
   Memory.decRef(WasmI32.fromGrain(bytes))
   Memory.decRef(WasmI32.fromGrain(toString))
   ret
@@ -172,7 +172,7 @@ export let rec copy = (b: Bytes) => {
   let size = getSize(src)
   let dst = allocateBytes(size)
   Memory.copy(dst + _VALUE_OFFSET, src + _VALUE_OFFSET, size)
-  let ret = WasmI32.toGrain(dst): (Bytes)
+  let ret = WasmI32.toGrain(dst): Bytes
   Memory.decRef(WasmI32.fromGrain(b))
   Memory.decRef(WasmI32.fromGrain(copy))
   ret
@@ -200,13 +200,13 @@ export let rec slice = (start: Number, length: Number, bytes: Bytes) => {
   let length = coerceNumberToWasmI32(length)
   if (start + length > size) {
     throw Exception.InvalidArgument(
-      "The given index and length do not specify a valid range of bytes",
+      "The given index and length do not specify a valid range of bytes"
     )
   }
   let dst = allocateBytes(length)
   let offset = start
   Memory.copy(dst + _VALUE_OFFSET, src + _VALUE_OFFSET + start, length)
-  let ret = WasmI32.toGrain(dst): (Bytes)
+  let ret = WasmI32.toGrain(dst): Bytes
   Memory.decRef(WasmI32.fromGrain(iOrig))
   Memory.decRef(WasmI32.fromGrain(lenOrig))
   Memory.decRef(WasmI32.fromGrain(bytes))
@@ -263,10 +263,10 @@ export let rec resize = (left: Number, right: Number, bytes: Bytes) => {
     Memory.copy(
       dst + _VALUE_OFFSET + dstOffset,
       src + _VALUE_OFFSET + srcOffset,
-      len,
+      len
     )
   }
-  let ret = WasmI32.toGrain(dst): (Bytes)
+  let ret = WasmI32.toGrain(dst): Bytes
   Memory.decRef(WasmI32.fromGrain(leftOrig))
   Memory.decRef(WasmI32.fromGrain(rightOrig))
   Memory.decRef(WasmI32.fromGrain(bytes))
@@ -317,7 +317,7 @@ export let rec move =
   let ret = Memory.copy(
     dst + _VALUE_OFFSET + dstIndex,
     src + _VALUE_OFFSET + srcIndex,
-    length,
+    length
   )
 
   Memory.decRef(WasmI32.fromGrain(srcIndexOrig))