@grain/stdlib 0.5.13 → 0.6.0

package/sys/process.gr

@@ -1,254 +0,0 @@
-/**
- * @module Process: Utilities for accessing functionality and information about the Grain program's process.
- *
- * This includes things like accessing environment variables and sending signals.
- *
- * @example import Process from "sys/process"
- */
-
-import WasmI32, {
-  add as (+),
-  mul as (*),
-  shrS as (>>),
-  shrU as (>>>),
-  and as (&),
-  eq as (==),
-  ne as (!=),
-  ltS as (<),
-} from "runtime/unsafe/wasmi32"
-import Memory from "runtime/unsafe/memory"
-import Wasi from "runtime/wasi"
-import {
-  tagSimpleNumber,
-  allocateArray,
-  allocateString,
-} from "runtime/dataStructures"
-
-/**
- * @section Types: Type declarations included in the Process module.
- */
-
-/**
- * Signals that can be sent to the host system.
- */
-export enum Signal {
-  // Hangup.
-  HUP,
-  // Terminate interrupt signal.
-  INT,
-  // Terminal quit signal.
-  QUIT,
-  // Illegal instruction.
-  ILL,
-  // Trace/breakpoint trap.
-  TRAP,
-  // Process abort signal.
-  ABRT,
-  // Access to an undefined portion of a memory object.
-  BUS,
-  // Erroneous arithmetic operation.
-  FPE,
-  // Kill.
-  KILL,
-  // User-defined signal 1.
-  USR1,
-  // Invalid memory reference.
-  SEGV,
-  // User-defined signal 2.
-  USR2,
-  // Write on a pipe with no one to read it.
-  PIPE,
-  // Alarm clock.
-  ALRM,
-  // Termination signal.
-  TERM,
-  // Child process terminated, stopped, or continued.
-  CHLD,
-  // Continue executing, if stopped.
-  CONT,
-  // Stop executing.
-  STOP,
-  // Terminal stop signal.
-  TSTP,
-  // Background process attempting read.
-  TTIN,
-  // Background process attempting write.
-  TTOU,
-  // High bandwidth data is available at a socket.
-  URG,
-  // CPU time limit exceeded.
-  XCPU,
-  // File size limit exceeded.
-  XFSZ,
-  // Virtual timer expired.
-  VTALRM,
-  PROF,
-  WINCH,
-  POLL,
-  PWR,
-  // Bad system call.
-  SYS,
-}
-
-/**
- * @section Values: Functions and constants included in the Process module.
- */
-
-/**
- * Access command line arguments.
- *
- * @returns `Ok(args)` of an array containing positional string arguments to the process if successful or `Err(exception)` otherwise
- */
-@unsafe
-export let argv = () => {
-  let argcPtr = Memory.malloc(8n)
-  let argvBufSizePtr = argcPtr + 4n
-
-  let mut err = Wasi.args_sizes_get(argcPtr, argvBufSizePtr)
-  if (err != Wasi._ESUCCESS) {
-    Memory.free(argcPtr)
-    Err(Wasi.SystemError(tagSimpleNumber(err)))
-  } else {
-    let argc = WasmI32.load(argcPtr, 0n)
-    let argvBufSize = WasmI32.load(argvBufSizePtr, 0n)
-
-    let argvPtr = Memory.malloc(argc * 4n)
-    let argvBufPtr = Memory.malloc(argvBufSize)
-
-    err = Wasi.args_get(argvPtr, argvBufPtr)
-    if (err != Wasi._ESUCCESS) {
-      Memory.free(argcPtr)
-      Memory.free(argvPtr)
-      Memory.free(argvBufPtr)
-      Err(Wasi.SystemError(tagSimpleNumber(err)))
-    } else {
-      let arr = allocateArray(argc)
-
-      let argsLength = argc * 4n
-      for (let mut i = 0n; i < argsLength; i += 4n) {
-        let strPtr = WasmI32.load(argvPtr + i, 0n)
-        let mut strLength = 0n
-        while (WasmI32.load8U(strPtr + strLength, 0n) != 0n) {
-          strLength += 1n
-        }
-
-        let grainStrPtr = allocateString(strLength)
-        Memory.copy(grainStrPtr + 8n, strPtr, strLength)
-
-        WasmI32.store(arr + i, grainStrPtr, 8n)
-      }
-
-      Memory.free(argcPtr)
-      Memory.free(argvPtr)
-      Memory.free(argvBufPtr)
-
-      Ok(WasmI32.toGrain(arr): Array<String>)
-    }
-  }
-}
-
-/**
- * Access environment variables.
- *
- * @returns `Ok(vars)` of an array containing environment variables supplied to the process if successful or `Err(exception)` otherwise
- */
-@unsafe
-export let env = () => {
-  let envcPtr = Memory.malloc(8n)
-  let envvBufSizePtr = envcPtr + 4n
-
-  let mut err = Wasi.environ_sizes_get(envcPtr, envvBufSizePtr)
-  if (err != Wasi._ESUCCESS) {
-    Memory.free(envcPtr)
-    Err(Wasi.SystemError(tagSimpleNumber(err)))
-  } else {
-    let envc = WasmI32.load(envcPtr, 0n)
-    let envvBufSize = WasmI32.load(envvBufSizePtr, 0n)
-
-    let envvPtr = Memory.malloc(envc * 4n)
-    let envvBufPtr = Memory.malloc(envvBufSize)
-
-    err = Wasi.environ_get(envvPtr, envvBufPtr)
-    if (err != Wasi._ESUCCESS) {
-      Memory.free(envcPtr)
-      Memory.free(envvPtr)
-      Memory.free(envvBufPtr)
-      Err(Wasi.SystemError(tagSimpleNumber(err)))
-    } else {
-      let arr = allocateArray(envc)
-
-      let envsLength = envc * 4n
-      for (let mut i = 0n; i < envsLength; i += 4n) {
-        let strPtr = WasmI32.load(envvPtr + i, 0n)
-        let mut strLength = 0n
-        while (WasmI32.load8U(strPtr + strLength, 0n) != 0n) {
-          strLength += 1n
-        }
-
-        let grainStrPtr = allocateString(strLength)
-        Memory.copy(grainStrPtr + 8n, strPtr, strLength)
-
-        WasmI32.store(arr + i, grainStrPtr, 8n)
-      }
-
-      Memory.free(envcPtr)
-      Memory.free(envvPtr)
-      Memory.free(envvBufPtr)
-
-      Ok(WasmI32.toGrain(arr): Array<String>)
-    }
-  }
-}
-
-/**
- * Terminate the process normally.
- *
- * @param code: The value to exit with. An exit code of 0 is considered normal, with other values having meaning depending on the platform
- * @returns `Err(exception)` if unsuccessful. Will not actually return a value if successful, as the process has ended
- */
-@unsafe
-export let exit = (code: Number) => {
-  let mut code = WasmI32.fromGrain(code)
-
-  if ((code & 1n) == 0n) {
-    Err(InvalidArgument("Invalid exit code"))
-  } else {
-    code = code >> 1n
-    Wasi.proc_exit(code)
-    // Never actually hit because it exited
-    Ok(void)
-  }
-}
-
-/**
- * Send a signal to the process of the calling thread.
- *
- * @param signal: The signal to send
- * @returns `Ok(void)` if successful or `Err(exception)` otherwise
- */
-@unsafe
-export let sigRaise = (signalPtr: Signal) => {
-  let signal = WasmI32.fromGrain(signalPtr)
-  let signal = WasmI32.load(signal, 12n) >> 1n
-  let err = Wasi.proc_raise(signal)
-  if (err != Wasi._ESUCCESS) {
-    Err(Wasi.SystemError(tagSimpleNumber(err)))
-  } else {
-    Ok(void)
-  }
-}
-
-/**
- * Yield execution to the calling thread.
- *
- * @returns `Ok(void)` if successful or `Err(exception)` otherwise
- */
-@unsafe
-export let schedYield = () => {
-  let err = Wasi.sched_yield()
-  if (err != Wasi._ESUCCESS) {
-    Err(Wasi.SystemError(tagSimpleNumber(err)))
-  } else {
-    Ok(void)
-  }
-}

package/sys/random.gr

@@ -1,79 +0,0 @@
-/**
- * @module Random: System access to random values.
- *
- * @example import Random from "sys/random"
- */
-
-import WasmI32, { eq as (==), ne as (!=) } from "runtime/unsafe/wasmi32"
-import WasmI64 from "runtime/unsafe/wasmi64"
-import Memory from "runtime/unsafe/memory"
-import Wasi from "runtime/wasi"
-import { tagSimpleNumber, newInt32, newInt64 } from "runtime/dataStructures"
-
-/**
- * @section Values: Functions and constants included in the Random module.
- */
-
-/**
- * Produce a random 32-bit integer. This function can be slow, so it's best to seed a generator if lots of random data is needed.
- *
- * @returns `Ok(num)` of a random Int32 if successful or `Err(exception)` otherwise
- *
- * @since v0.5.0
- */
-@unsafe
-export let randomInt32 = () => {
-  let buf = Memory.malloc(4n)
-
-  let err = Wasi.random_get(buf, 4n)
-  if (err != Wasi._ESUCCESS) {
-    Memory.free(buf)
-    Err(Wasi.SystemError(tagSimpleNumber(err)))
-  } else {
-    let rand = WasmI32.load(buf, 0n)
-    Memory.free(buf)
-    Ok(WasmI32.toGrain(newInt32(rand)): Int32)
-  }
-}
-
-/**
- * Produce a random 64-bit integer. This function can be slow, so it's best to seed a generator if lots of random data is needed.
- *
- * @returns `Ok(num)` of a random Int64 if successful or `Err(exception)` otherwise
- *
- * @since v0.5.0
- */
-@unsafe
-export let randomInt64 = () => {
-  let buf = Memory.malloc(8n)
-
-  let err = Wasi.random_get(buf, 8n)
-  if (err != Wasi._ESUCCESS) {
-    Memory.free(buf)
-    Err(Wasi.SystemError(tagSimpleNumber(err)))
-  } else {
-    let rand = WasmI64.load(buf, 0n)
-    Memory.free(buf)
-    Ok(WasmI32.toGrain(newInt64(rand)): Int64)
-  }
-}
-
-/**
- * Produce a random number. This function can be slow, so it's best to seed a generator if lots of random data is needed.
- *
- * @returns `Ok(num)` of a random number if successful or `Err(exception)` otherwise
- */
-@unsafe
-export let random = () => {
-  let buf = Memory.malloc(4n)
-
-  let err = Wasi.random_get(buf, 4n)
-  if (err != Wasi._ESUCCESS) {
-    Memory.free(buf)
-    Err(Wasi.SystemError(tagSimpleNumber(err)))
-  } else {
-    let rand = WasmI32.load(buf, 0n)
-    Memory.free(buf)
-    Ok(tagSimpleNumber(rand))
-  }
-}

package/sys/random.md

@@ -1,66 +0,0 @@
----
-title: Random
----
-
-System access to random values.
-
-```grain
-import Random from "sys/random"
-```
-
-## Values
-
-Functions and constants included in the Random module.
-
-### Random.**randomInt32**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.0</code></summary>
-No other changes yet.
-</details>
-
-```grain
-randomInt32 : () -> Result<Int32, Exception>
-```
-
-Produce a random 32-bit integer. This function can be slow, so it's best to seed a generator if lots of random data is needed.
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Result<Int32, Exception>`|`Ok(num)` of a random Int32 if successful or `Err(exception)` otherwise|
-
-### Random.**randomInt64**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.5.0</code></summary>
-No other changes yet.
-</details>
-
-```grain
-randomInt64 : () -> Result<Int64, Exception>
-```
-
-Produce a random 64-bit integer. This function can be slow, so it's best to seed a generator if lots of random data is needed.
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Result<Int64, Exception>`|`Ok(num)` of a random Int64 if successful or `Err(exception)` otherwise|
-
-### Random.**random**
-
-```grain
-random : () -> Result<Number, Exception>
-```
-
-Produce a random number. This function can be slow, so it's best to seed a generator if lots of random data is needed.
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Result<Number, Exception>`|`Ok(num)` of a random number if successful or `Err(exception)` otherwise|
-