krgamestudios/Toy
1
0
Fork 0
mirror of https://github.com/krgamestudios/Toy.git synced 2026-04-15 23:04:08 +10:00
Code Issues Packages Projects Releases Wiki Activity

Merged standard and compound

Browse Source
This commit is contained in:
Kayne Ruse
2023-02-14 01:08:02 +11:00
committed by GitHub
parent c58f8678fc
commit e470dc21ff
3 changed files with 135 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -43,16 +43,13 @@ print tally(); //3
* [Quick Start Guide](quick-start-guide) * [Quick Start Guide](quick-start-guide)
* [Types](types) * [Types](types)
* [Standard Library](standard-library)
* [About Library](about-library) * [About Library](about-library)
* [Compound Library](compound-library) (under development) * [Standard Library](standard-library)
* ~~[Timer Library](timer-library)~~ (currently disabled)
* [Runner Library](runner-library) * [Runner Library](runner-library)
* [Game Engine](game-engine) * [Game Engine](game-engine)
# Deep Dive # Deep Dive
* [Theorizing Toy](theorizing-toy)
* [Embedding Toy](embedding-toy) * [Embedding Toy](embedding-toy)
* [Using Toy](using-toy) * [Using Toy](using-toy)
* [Compiling Toy](compiling-toy) * [Compiling Toy](compiling-toy)
@@ -60,6 +57,3 @@ print tally(); //3
* [Testing Toy](testing-toy) * [Testing Toy](testing-toy)
* [Roadmap](roadmap) * [Roadmap](roadmap)
# Version Differences
There have been a number of versions of Toy over the years, the current actively developed version is in the `main` branch for the time being. The best version to use is either the code in the main branch, or the latest tagged version.

145
compound-library.md
View File

@@ -1,145 +0,0 @@
# Compound Library
The compound library contains a number of common utility functions for use with compound values, such as arrays, dictionaries and strings. These functions will allow you to manipulate these values in ways that would otherwise be quite difficult and inefficient using just Toy.
The compound library is currently under development.
The compound library can usually be accessed with the `import` keyword:
```
import compound;
```
## _concat(self, other)
This function only works when self and other are matching compounds (both arrays, dictionaries or strings). It returns a new compound of that kind, with the content of `other` appended to the content of `self`.
## _containsKey(self: dictionary, key)
This function returns `true` if `self` contains the given `key`, otherwise it returns false.
## _containsValue(self, value)
This function returns `true` if `self` contains the given `value`, otherwise it returns false.
## _every(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `false`, at which point this function returns `false`. Otherwise this function returns `true`.
## _forEach(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time.
```
import compound;
fn p(i, x) {
print x;
}
var a = [1, 3, 5];
a.forEach(p); //prints 1, 3, and 5 to stdout
```
## _filter(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, and the function returns a new compound for every element that `func` returned a truthy value for.
## _getKeys(self: dictionary)
This returns an array of all non-null keys stored within the dictionary. The order is undefined.
## _getValues(self: dictionary)
This returns an array of all values with non-null keys stored within the dictionary. The order is undefined.
## _indexOf(self: array, value)
This function returns the first index within `self` that is equal to `value`, or `null` if none are found.
## _map(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. It returns an array with the results of each call - the order of the results when called on a dictionary are undefined.
```
import compound;
fn increment(k, v) {
return v + 1;
}
var a = [1, 2, 3];
print a.map(increment); //prints [2,3,4];
```
## _reduce(self, default, func: fn)
This function takes either an array or a dictionary as the `self` argument, a default value, and a function as `func`. The argument `func` takes three arguments - the first is the accumulator, the second is the index/key and the third is the value. It applies the given function to every element of the array/dictionary, passing the result of each call as the accumulator to the next (the default value is used for the first call). Finally, the final value of the accumulator is returned to the caller.
```
import compound;
fn f(acc, k, v) {
return acc + v;
}
var a = [1, 2, 3, 4];
print a.reduce(0, f); //prints "10"
```
## _some(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `true`, at which point this function returns `true`. Otherwise this function returns `false`.
## _sort(self: array, func: fn)
This function takes an array as the `self` argument, and a comparison function as `func`. The argument `func` must take two arguments, and return a truthy or falsy value. The contents of the array in `self` are sorted based on the results of `func`, as though function were the less comparison function.
```
import compound;
fn less(a, b) {
return a < b;
}
var a = [4, 2, 3, 1];
print a.sort(less); //prints "[1, 2, 3, 4]"
```
## _toLower(self: string)
This function returns a new string which is identical to the string `self`, except any uppercase letters are replaced with the corresponding lowercase letters.
## _toString(self)
This function returns a string representation of `self`. This is intended for arrays and dictionaries, but can theoretically work on any printable value.
If the resulting string is longer than `TOY_MAX_STRING_LENGTH` - 1, then it is truncated.
## _toUpper(self: string)
This function returns a new string which is identical to the string `self`, except any lowercase letters are replaced with the corresponding uppercase letters.
## _trim(self: string, trimChars: string = " \t\n\r")
This function returns a new string which is identical to the string `self`, except any characters at the beginning or end of `self` which are present in the argument `trimChars` are removed. The argument `trimChars` is optional, and has the following characters as the default value:
* The space character
* The horizontal tab character
* The newline character
* The carriage return character
These characters used because they are the only control characters currently supported by Toy.
## _trimBegin(self: string, trimChars: string = " \t\n\r")
This is identical to `_trim(self, trimChars)`, except it is only applied to the beginning of the first argument.
## _trimEnd(self: string, trimChars: string = " \t\n\r")
This is identical to `_trim(self, trimChars)`, except it is only applied to the end of the first argument.

135
standard-library.md
View File

@@ -1,6 +1,6 @@
# Standard Library # Standard Library
The standard library offers a number of miscellaneous utility functions, which can be used for various purposes. These functions are implemented by the host program, so they may not all be provided by default. The standard library offers a number of miscellaneous utility functions, which can be used for various purposes. These are the most commonly used functions, so the standard library is almost certain to be included in the host program.
The standard library can usually be accessed with the `import` keyword: The standard library can usually be accessed with the `import` keyword:
@@ -12,3 +12,136 @@ import standard;
This function returns a string representation of the current timestamp. This function returns a string representation of the current timestamp.
## _concat(self, other)
This function only works when self and other are matching compounds (both arrays, dictionaries or strings). It returns a new compound of that kind, with the content of `other` appended to the content of `self`.
## _containsKey(self: dictionary, key)
This function returns `true` if `self` contains the given `key`, otherwise it returns false.
## _containsValue(self, value)
This function returns `true` if `self` contains the given `value`, otherwise it returns false.
## _every(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `false`, at which point this function returns `false`. Otherwise this function returns `true`.
## _forEach(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time.
```
import compound;
fn p(i, x) {
print x;
}
var a = [1, 3, 5];
a.forEach(p); //prints 1, 3, and 5 to stdout
```
## _filter(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, and the function returns a new compound for every element that `func` returned a truthy value for.
## _getKeys(self: dictionary)
This returns an array of all non-null keys stored within the dictionary. The order is undefined.
## _getValues(self: dictionary)
This returns an array of all values with non-null keys stored within the dictionary. The order is undefined.
## _indexOf(self: array, value)
This function returns the first index within `self` that is equal to `value`, or `null` if none are found.
## _map(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. It returns an array with the results of each call - the order of the results when called on a dictionary are undefined.
```
import compound;
fn increment(k, v) {
return v + 1;
}
var a = [1, 2, 3];
print a.map(increment); //prints [2,3,4];
```
## _reduce(self, default, func: fn)
This function takes either an array or a dictionary as the `self` argument, a default value, and a function as `func`. The argument `func` takes three arguments - the first is the accumulator, the second is the index/key and the third is the value. It applies the given function to every element of the array/dictionary, passing the result of each call as the accumulator to the next (the default value is used for the first call). Finally, the final value of the accumulator is returned to the caller.
```
import compound;
fn f(acc, k, v) {
return acc + v;
}
var a = [1, 2, 3, 4];
print a.reduce(0, f); //prints "10"
```
## _some(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `true`, at which point this function returns `true`. Otherwise this function returns `false`.
## _sort(self: array, func: fn)
This function takes an array as the `self` argument, and a comparison function as `func`. The argument `func` must take two arguments, and return a truthy or falsy value. The contents of the array in `self` are sorted based on the results of `func`, as though function were the less comparison function.
```
import compound;
fn less(a, b) {
return a < b;
}
var a = [4, 2, 3, 1];
print a.sort(less); //prints "[1, 2, 3, 4]"
```
## _toLower(self: string)
This function returns a new string which is identical to the string `self`, except any uppercase letters are replaced with the corresponding lowercase letters.
## _toString(self)
This function returns a string representation of `self`. This is intended for arrays and dictionaries, but can theoretically work on any printable value.
If the resulting string is longer than `TOY_MAX_STRING_LENGTH` - 1, then it is truncated.
## _toUpper(self: string)
This function returns a new string which is identical to the string `self`, except any lowercase letters are replaced with the corresponding uppercase letters.
## _trim(self: string, trimChars: string = " \t\n\r")
This function returns a new string which is identical to the string `self`, except any characters at the beginning or end of `self` which are present in the argument `trimChars` are removed. The argument `trimChars` is optional, and has the following characters as the default value:
* The space character
* The horizontal tab character
* The newline character
* The carriage return character
These characters used because they are the only control characters currently supported by Toy.
## _trimBegin(self: string, trimChars: string = " \t\n\r")
This is identical to `_trim(self, trimChars)`, except it is only applied to the beginning of the first argument.
## _trimEnd(self: string, trimChars: string = " \t\n\r")
This is identical to `_trim(self, trimChars)`, except it is only applied to the end of the first argument.