X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=a2e93a733894541cece234c096ada5921ef36a79;hb=c990145e4dd7ca0e61f8ab5c1c906751df08e40d;hp=c87f13d35e5adad2f72804713361c7e96be6bf1c;hpb=e7f52e298f71cc2e7cb132abfb1c26bbe540309f;p=uwu-nolambda.git diff --git a/README.md b/README.md index c87f13d..a2e93a7 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,59 @@ # nolambda nolambda is a collection of native [uwu](https://github.com/EliasFleckenstein03/uwulang) modules that break the lambda paradigm, such as linear execution, I/O, globals etc. +## Building + +Make sure the submodules are checked out: + +```sh +git submodule update --init +``` + +Build: + +```sh +make uwu_include_path=/path/to/uwulang/repo +``` + ## Modules +Note: The module `nolambda:global` is not implemented yet. + ### `nolambda:flow` - `nolambda:flow:linear`: Accepts an arbitrary number of arguments of arbitrary type, but at least one and evaulates all of them in order. Returns the last argument. -- `nolambda:flow:error`: Accepts a string as $0, prints the string to stderr and exits the program with failure. +- `nolambda:flow:error`: Accepts an arbitrary type as $0, prints it to stderr appending a newline and exits the program with failure. Returns `:nil:nil` in theory. ### `nolambda:io` -- `nolambda:io:print`: Accepts a string as $0 and prints it to stdout, followed by a newline. -- `nolambda:io:scan`: Reads a line from stdin and returns it as a string, without the newline character at the end. This is interally using readline. +- `nolambda:io:print`: Accepts an arbitrary type as $0 and prints it to stdout, followed by a newline. Returns $0. +- `nolambda:io:scan`: Reads a line from stdin and returns it as a string, without the newline character at the end. If $0 is given, it is used as a prompt (after converting to string). ### `nolambda:fs` Note: all file paths are relative to the _directory the program was started from_. -- `nolambda:fs:read`: Accepts a file name (string) as $0 and returns it's contents as a string. Causes an error if the file does not exist. -- `nolambda:fs:write`: Accepts a file name (string) as $0 and overwrites it with the contents in $1 (string). Causes an error if the file could not be written. -- `nolambda:fs:remove`: Accepts a file name (string) as $0 and removes it from the file system. Causes an error if the file could not be removed, but does not cause an error if the file does not exist. -- `nolambda:fs:exists`: Accepts a file name (string) as $0 and returns `:bool:true` if it exists, `:bool:fase` else. +- `nolambda:fs:read`: Accepts a file name (arbirary value, converted to string) as $0 and returns it's contents as a string. Causes an error if the file does not exist. +- `nolambda:fs:write`: Accepts a file name (arbirary value, converted to string) as $0 and overwrites it with the contents in $1 (arbirary value, converted to string). Causes an error if the file could not be written. Returns `:nil:nil`. +- `nolambda:fs:remove`: Accepts an arbitrary number of file names (arbirary type, converted to string), but at least one and unlinks them from the file system (the files can also be a directories). Causes an error if one of the file could not be removed, or if some or all of the files did not exist in the first place. Returns `:nil:nil`. +- `nolambda:fs:exists`: Accepts an arbitrary number of file names (arbirary type, converted to string), but at least one and returns `:bool:true` if all of them exist, `:bool:fase` else. ### `nolambda:os` -- `nolambda:os:exit`: Optionally takes an exit code (integer) as $0 and exits the program with the given exit code, or 0 if no exit code was given. -- `nolambda:os:sleep`: Takes an integer as $0 and pauses the execution of the program for $1 milliseconds. -- `nolambda:os:execute`: Takes a command (string) as $0 and executes it as a shell command. Returns the exit code of the command as an integer. +- `nolambda:os:exit`: Optionally takes an exit code (integer) as $0 and exits the program with the given exit code, or 0 if no exit code was given. Returns `:nil:nil` in theory. +- `nolambda:os:sleep`: Takes an integer as $0 and pauses the execution of the program for $1 milliseconds. Returns `:nil:nil`. +- `nolambda:os:execute`: Takes a command (arbirary value, converted to string) as $0 and executes it as a shell command. Returns the exit code of the command as an integer. +- `nolambda:os:time`: Returns the current unix millis as an integer. ### `nolambda:global` -- `nolambda:global:set`: Creates or overwrites a global variable named $0 (string) and puts the contents of $1 (arbitrary type) into it. -- `nolambda:global:get`: Gets the global variable named $0 (string). Causes an error if the variable does not exist. -- `nolambda:global:exists`: Returns `:bool:true` if the global variable named $0 (string) exists, `:bool:false` else. -- `nolambda:global:delete`: Deletes the global variable named $0 (string). Does **not** cause an error if the variable does not exist. +- `nolambda:global:set`: Creates or overwrites a global variable named $0 (arbirary value, converted to string) and puts the contents of $1 (arbitrary type) into it. Returns `:bool:false` if the variable existed previously and was updated, `:bool:true` if it was created. +- `nolambda:global:get`: Returns the global variable named $0 (arbirary value, converted to string). Causes an error if the variable does not exist. +- `nolambda:global:exists`: Returns `:bool:true` if the global variable named $0 (arbirary value, converted to string) exists, `:bool:false` else. +- `nolambda:global:delete`: Deletes the global variable named $0 (arbirary value, converted to string). Returns `:bool:true` if the variable existed previously, `:bool:false` else. + +### `nolambda:random` + +- `nolambda:random:random`: Returns a pseudorandom integer between $0 (integer) and $1 (integer). The range is inclusive on both boundse. Causes an error if the range is bigger than `nolambda:random:max` or empty. +- `nolambda:random:max`: Returns RAND_MAX. +- `nolambda:random:seed`: Sets the random seed to $0 (integer) and returns `:nil:nil`.